sys/contrib/dev/acpica-unix-20061109/utilities/utalloc.c

   1 /******************************************************************************
   2  *
   3  * Module Name: utalloc - local memory allocation routines
   4  *              $Revision: 1.162 $
   5  *
   6  *****************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2006, Intel Corp.
  13  * All rights reserved.
  14  *
  15  * 2. License
  16  *
  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
  20  * property rights.
  21  *
  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
  28  *
  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;
  37  *
  38  * The above copyright and patent license is granted only if the following
  39  * conditions are met:
  40  *
  41  * 3. Conditions
  42  *
  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.
  54  *
  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
  65  * make.
  66  *
  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
  71  * distribution.
  72  *
  73  * 3.4. Intel retains all right, title, and interest in and to the Original
  74  * Intel Code.
  75  *
  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.
  80  *
  81  * 4. Disclaimer and Export Compliance
  82  *
  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
  89  * PARTICULAR PURPOSE.
  90  *
  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
  98  * LIMITED REMEDY.
  99  *
 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.
 114  *
 115  *****************************************************************************/
 116
 117 #define __UTALLOC_C__
 118
 119 #include "acpi.h"
 120
 121 #define _COMPONENT          ACPI_UTILITIES
 122         ACPI_MODULE_NAME    ("utalloc")
 123
 124
 125 /*******************************************************************************
 126  *
 127  * FUNCTION:    AcpiUtCreateCaches
 128  *
 129  * PARAMETERS:  None
 130  *
 131  * RETURN:      Status
 132  *
 133  * DESCRIPTION: Create all local caches
 134  *
 135  ******************************************************************************/
 136
 137 ACPI_STATUS
 138 AcpiUtCreateCaches (
 139     void)
 140 {
 141     ACPI_STATUS             Status;
 142
 143
 144     /* Object Caches, for frequently used objects */
 145
 146     Status = AcpiOsCreateCache ("Acpi-Namespace", sizeof (ACPI_NAMESPACE_NODE),
 147                 ACPI_MAX_NAMESPACE_CACHE_DEPTH, &AcpiGbl_NamespaceCache);
 148     if (ACPI_FAILURE (Status))
 149     {
 150         return (Status);
 151     }
 152
 153     Status = AcpiOsCreateCache ("Acpi-State", sizeof (ACPI_GENERIC_STATE),
 154                 ACPI_MAX_STATE_CACHE_DEPTH, &AcpiGbl_StateCache);
 155     if (ACPI_FAILURE (Status))
 156     {
 157         return (Status);
 158     }
 159
 160     Status = AcpiOsCreateCache ("Acpi-Parse", sizeof (ACPI_PARSE_OBJ_COMMON),
 161                 ACPI_MAX_PARSE_CACHE_DEPTH, &AcpiGbl_PsNodeCache);
 162     if (ACPI_FAILURE (Status))
 163     {
 164         return (Status);
 165     }
 166
 167     Status = AcpiOsCreateCache ("Acpi-ParseExt", sizeof (ACPI_PARSE_OBJ_NAMED),
 168                 ACPI_MAX_EXTPARSE_CACHE_DEPTH, &AcpiGbl_PsNodeExtCache);
 169     if (ACPI_FAILURE (Status))
 170     {
 171         return (Status);
 172     }
 173
 174     Status = AcpiOsCreateCache ("Acpi-Operand", sizeof (ACPI_OPERAND_OBJECT),
 175                 ACPI_MAX_OBJECT_CACHE_DEPTH, &AcpiGbl_OperandCache);
 176     if (ACPI_FAILURE (Status))
 177     {
 178         return (Status);
 179     }
 180
 181
 182 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
 183
 184     /* Memory allocation lists */
 185
 186     Status = AcpiUtCreateList ("Acpi-Global", 0,
 187                 &AcpiGbl_GlobalList);
 188     if (ACPI_FAILURE (Status))
 189     {
 190         return (Status);
 191     }
 192
 193     Status = AcpiUtCreateList ("Acpi-Namespace", sizeof (ACPI_NAMESPACE_NODE),
 194                 &AcpiGbl_NsNodeList);
 195     if (ACPI_FAILURE (Status))
 196     {
 197         return (Status);
 198     }
 199 #endif
 200
 201     return (AE_OK);
 202 }
 203
 204
 205 /*******************************************************************************
 206  *
 207  * FUNCTION:    AcpiUtDeleteCaches
 208  *
 209  * PARAMETERS:  None
 210  *
 211  * RETURN:      Status
 212  *
 213  * DESCRIPTION: Purge and delete all local caches
 214  *
 215  ******************************************************************************/
 216
 217 ACPI_STATUS
 218 AcpiUtDeleteCaches (
 219     void)
 220 {
 221
 222     (void) AcpiOsDeleteCache (AcpiGbl_NamespaceCache);
 223     AcpiGbl_NamespaceCache = NULL;
 224
 225     (void) AcpiOsDeleteCache (AcpiGbl_StateCache);
 226     AcpiGbl_StateCache = NULL;
 227
 228     (void) AcpiOsDeleteCache (AcpiGbl_OperandCache);
 229     AcpiGbl_OperandCache = NULL;
 230
 231     (void) AcpiOsDeleteCache (AcpiGbl_PsNodeCache);
 232     AcpiGbl_PsNodeCache = NULL;
 233
 234     (void) AcpiOsDeleteCache (AcpiGbl_PsNodeExtCache);
 235     AcpiGbl_PsNodeExtCache = NULL;
 236
 237
 238 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
 239
 240     /* Debug only - display leftover memory allocation, if any */
 241
 242     AcpiUtDumpAllocations (ACPI_UINT32_MAX, NULL);
 243
 244     /* Free memory lists */
 245
 246     AcpiOsFree (AcpiGbl_GlobalList);
 247     AcpiGbl_GlobalList = NULL;
 248
 249     AcpiOsFree (AcpiGbl_NsNodeList);
 250     AcpiGbl_NsNodeList = NULL;
 251 #endif
 252
 253     return (AE_OK);
 254 }
 255
 256
 257 /*******************************************************************************
 258  *
 259  * FUNCTION:    AcpiUtValidateBuffer
 260  *
 261  * PARAMETERS:  Buffer              - Buffer descriptor to be validated
 262  *
 263  * RETURN:      Status
 264  *
 265  * DESCRIPTION: Perform parameter validation checks on an ACPI_BUFFER
 266  *
 267  ******************************************************************************/
 268
 269 ACPI_STATUS
 270 AcpiUtValidateBuffer (
 271     ACPI_BUFFER             *Buffer)
 272 {
 273
 274     /* Obviously, the structure pointer must be valid */
 275
 276     if (!Buffer)
 277     {
 278         return (AE_BAD_PARAMETER);
 279     }
 280
 281     /* Special semantics for the length */
 282
 283     if ((Buffer->Length == ACPI_NO_BUFFER)              ||
 284         (Buffer->Length == ACPI_ALLOCATE_BUFFER)        ||
 285         (Buffer->Length == ACPI_ALLOCATE_LOCAL_BUFFER))
 286     {
 287         return (AE_OK);
 288     }
 289
 290     /* Length is valid, the buffer pointer must be also */
 291
 292     if (!Buffer->Pointer)
 293     {
 294         return (AE_BAD_PARAMETER);
 295     }
 296
 297     return (AE_OK);
 298 }
 299
 300
 301 /*******************************************************************************
 302  *
 303  * FUNCTION:    AcpiUtInitializeBuffer
 304  *
 305  * PARAMETERS:  Buffer              - Buffer to be validated
 306  *              RequiredLength      - Length needed
 307  *
 308  * RETURN:      Status
 309  *
 310  * DESCRIPTION: Validate that the buffer is of the required length or
 311  *              allocate a new buffer.  Returned buffer is always zeroed.
 312  *
 313  ******************************************************************************/
 314
 315 ACPI_STATUS
 316 AcpiUtInitializeBuffer (
 317     ACPI_BUFFER             *Buffer,
 318     ACPI_SIZE               RequiredLength)
 319 {
 320     ACPI_STATUS             Status = AE_OK;
 321
 322
 323     switch (Buffer->Length)
 324     {
 325     case ACPI_NO_BUFFER:
 326
 327         /* Set the exception and returned the required length */
 328
 329         Status = AE_BUFFER_OVERFLOW;
 330         break;
 331
 332
 333     case ACPI_ALLOCATE_BUFFER:
 334
 335         /* Allocate a new buffer */
 336
 337         Buffer->Pointer = AcpiOsAllocate (RequiredLength);
 338         if (!Buffer->Pointer)
 339         {
 340             return (AE_NO_MEMORY);
 341         }
 342
 343         /* Clear the buffer */
 344
 345         ACPI_MEMSET (Buffer->Pointer, 0, RequiredLength);
 346         break;
 347
 348
 349     case ACPI_ALLOCATE_LOCAL_BUFFER:
 350
 351         /* Allocate a new buffer with local interface to allow tracking */
 352
 353         Buffer->Pointer = ACPI_ALLOCATE_ZEROED (RequiredLength);
 354         if (!Buffer->Pointer)
 355         {
 356             return (AE_NO_MEMORY);
 357         }
 358         break;
 359
 360
 361     default:
 362
 363         /* Existing buffer: Validate the size of the buffer */
 364
 365         if (Buffer->Length < RequiredLength)
 366         {
 367             Status = AE_BUFFER_OVERFLOW;
 368             break;
 369         }
 370
 371         /* Clear the buffer */
 372
 373         ACPI_MEMSET (Buffer->Pointer, 0, RequiredLength);
 374         break;
 375     }
 376
 377     Buffer->Length = RequiredLength;
 378     return (Status);
 379 }
 380
 381
 382 /*******************************************************************************
 383  *
 384  * FUNCTION:    AcpiUtAllocate
 385  *
 386  * PARAMETERS:  Size                - Size of the allocation
 387  *              Component           - Component type of caller
 388  *              Module              - Source file name of caller
 389  *              Line                - Line number of caller
 390  *
 391  * RETURN:      Address of the allocated memory on success, NULL on failure.
 392  *
 393  * DESCRIPTION: Subsystem equivalent of malloc.
 394  *
 395  ******************************************************************************/
 396
 397 void *
 398 AcpiUtAllocate (
 399     ACPI_SIZE               Size,
 400     UINT32                  Component,
 401     char                    *Module,
 402     UINT32                  Line)
 403 {
 404     void                    *Allocation;
 405
 406
 407     ACPI_FUNCTION_TRACE_U32 (UtAllocate, Size);
 408
 409
 410     /* Check for an inadvertent size of zero bytes */
 411
 412     if (!Size)
 413     {
 414         ACPI_WARNING ((Module, Line,
 415             "Attempt to allocate zero bytes, allocating 1 byte"));
 416         Size = 1;
 417     }
 418
 419     Allocation = AcpiOsAllocate (Size);
 420     if (!Allocation)
 421     {
 422         /* Report allocation error */
 423
 424         ACPI_WARNING ((Module, Line,
 425             "Could not allocate size %X", (UINT32) Size));
 426
 427         return_PTR (NULL);
 428     }
 429
 430     return_PTR (Allocation);
 431 }
 432
 433
 434 /*******************************************************************************
 435  *
 436  * FUNCTION:    AcpiUtAllocateZeroed
 437  *
 438  * PARAMETERS:  Size                - Size of the allocation
 439  *              Component           - Component type of caller
 440  *              Module              - Source file name of caller
 441  *              Line                - Line number of caller
 442  *
 443  * RETURN:      Address of the allocated memory on success, NULL on failure.
 444  *
 445  * DESCRIPTION: Subsystem equivalent of calloc. Allocate and zero memory.
 446  *
 447  ******************************************************************************/
 448
 449 void *
 450 AcpiUtAllocateZeroed (
 451     ACPI_SIZE               Size,
 452     UINT32                  Component,
 453     char                    *Module,
 454     UINT32                  Line)
 455 {
 456     void                    *Allocation;
 457
 458
 459     ACPI_FUNCTION_ENTRY ();
 460
 461
 462     Allocation = AcpiUtAllocate (Size, Component, Module, Line);
 463     if (Allocation)
 464     {
 465         /* Clear the memory block */
 466
 467         ACPI_MEMSET (Allocation, 0, Size);
 468     }
 469
 470     return (Allocation);
 471 }
 472