utalloc.c revision 450d696485d078017a0c7d3eef7384ee79c9f467
/******************************************************************************
*
* Module Name: utalloc - local memory allocation routines
* $Revision: 146 $
*
*****************************************************************************/
/******************************************************************************
*
* 1. Copyright Notice
*
* Some or all of this work - Copyright (c) 1999 - 2005, Intel Corp.
* All rights reserved.
*
* 2. License
*
* 2.1. This is your license from Intel Corp. under its intellectual property
* rights. You may have additional license terms from the party that provided
* you this software, covering your right to use that party's intellectual
* property rights.
*
* 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
* copy of the source code appearing in this file ("Covered Code") an
* irrevocable, perpetual, worldwide license under Intel's copyrights in the
* base code distributed originally by Intel ("Original Intel Code") to copy,
* make derivatives, distribute, use and display any portion of the Covered
* Code in any form, with the right to sublicense such rights; and
*
* 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
* license (with the right to sublicense), under only those claims of Intel
* patents that are infringed by the Original Intel Code, to make, use, sell,
* offer to sell, and import the Covered Code and derivative works thereof
* solely to the minimum extent necessary to exercise the above copyright
* license, and in no event shall the patent license extend to any additions
* to or modifications of the Original Intel Code. No other license or right
* is granted directly or by implication, estoppel or otherwise;
*
* The above copyright and patent license is granted only if the following
* conditions are met:
*
* 3. Conditions
*
* 3.1. Redistribution of Source with Rights to Further Distribute Source.
* Redistribution of source code of any substantial portion of the Covered
* Code or modification with rights to further distribute source must include
* the above Copyright Notice, the above License, this list of Conditions,
* and the following Disclaimer and Export Compliance provision. In addition,
* Licensee must cause all Covered Code to which Licensee contributes to
* contain a file documenting the changes Licensee made to create that Covered
* Code and the date of any change. Licensee must include in that file the
* documentation of any changes made by any predecessor Licensee. Licensee
* must include a prominent statement that the modification is derived,
* directly or indirectly, from Original Intel Code.
*
* 3.2. Redistribution of Source with no Rights to Further Distribute Source.
* Redistribution of source code of any substantial portion of the Covered
* Code or modification without rights to further distribute source must
* include the following Disclaimer and Export Compliance provision in the
* addition, Licensee may not authorize further sublicense of source of any
* portion of the Covered Code, and must include terms to the effect that the
* license from Licensee to its licensee is limited to the intellectual
* property embodied in the software Licensee provides to its licensee, and
* not to intellectual property embodied in modifications its licensee may
* make.
*
* 3.3. Redistribution of Executable. Redistribution in executable form of any
* substantial portion of the Covered Code or modification must reproduce the
* above Copyright Notice, and the following Disclaimer and Export Compliance
* distribution.
*
* 3.4. Intel retains all right, title, and interest in and to the Original
* Intel Code.
*
* 3.5. Neither the name Intel nor any other trademark owned or controlled by
* Intel shall be used in advertising or otherwise to promote the sale, use or
* other dealings in products derived from or relating to the Covered Code
* without prior written authorization from Intel.
*
* 4. Disclaimer and Export Compliance
*
* 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
* HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
* IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
* INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
* UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
* IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
* PARTICULAR PURPOSE.
*
* 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
* OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
* COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
* SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
* CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
* HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
* SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
* LIMITED REMEDY.
*
* 4.3. Licensee shall not export, either directly or indirectly, any of this
* software or system incorporating such software without first obtaining any
* required license or other approval from the U. S. Department of Commerce or
* any other agency or department of the United States Government. In the
* event Licensee exports any such software from the United States or
* re-exports any such software from a foreign destination, Licensee shall
* compliance with all laws, regulations, orders, or other restrictions of the
* U.S. Export Administration Regulations. Licensee agrees that neither it nor
* software, or service, directly or indirectly, to any country for which the
* United States government or any agency thereof requires an export license,
* other governmental approval, or letter of assurance, without first obtaining
* such license, approval or letter.
*
*****************************************************************************/
#define __UTALLOC_C__
#include "acpi.h"
#define _COMPONENT ACPI_UTILITIES
ACPI_MODULE_NAME ("utalloc")
/* Local prototypes */
static ACPI_DEBUG_MEM_BLOCK *
void *Allocation);
static ACPI_STATUS
char *Module,
static ACPI_STATUS
char *Module,
#ifdef ACPI_DBG_TRACK_ALLOCATIONS
static ACPI_STATUS
char *ListName,
#endif
/*******************************************************************************
*
* FUNCTION: AcpiUtCreateCaches
*
* PARAMETERS: None
*
* RETURN: Status
*
* DESCRIPTION: Create all local caches
*
******************************************************************************/
void)
{
#ifdef ACPI_DBG_TRACK_ALLOCATIONS
/* Memory allocation lists */
if (ACPI_FAILURE (Status))
{
return (Status);
}
if (ACPI_FAILURE (Status))
{
return (Status);
}
#endif
/* Object Caches, for frequently used objects */
if (ACPI_FAILURE (Status))
{
return (Status);
}
if (ACPI_FAILURE (Status))
{
return (Status);
}
if (ACPI_FAILURE (Status))
{
return (Status);
}
if (ACPI_FAILURE (Status))
{
return (Status);
}
return (AE_OK);
}
/*******************************************************************************
*
* FUNCTION: AcpiUtDeleteCaches
*
* PARAMETERS: None
*
* RETURN: Status
*
* DESCRIPTION: Purge and delete all local caches
*
******************************************************************************/
void)
{
(void) AcpiOsDeleteCache (AcpiGbl_StateCache);
(void) AcpiOsDeleteCache (AcpiGbl_OperandCache);
(void) AcpiOsDeleteCache (AcpiGbl_PsNodeCache);
(void) AcpiOsDeleteCache (AcpiGbl_PsNodeExtCache);
return (AE_OK);
}
/*******************************************************************************
*
* FUNCTION: AcpiUtValidateBuffer
*
* PARAMETERS: Buffer - Buffer descriptor to be validated
*
* RETURN: Status
*
* DESCRIPTION: Perform parameter validation checks on an ACPI_BUFFER
*
******************************************************************************/
{
/* Obviously, the structure pointer must be valid */
if (!Buffer)
{
return (AE_BAD_PARAMETER);
}
/* Special semantics for the length */
{
return (AE_OK);
}
/* Length is valid, the buffer pointer must be also */
{
return (AE_BAD_PARAMETER);
}
return (AE_OK);
}
/*******************************************************************************
*
* FUNCTION: AcpiUtInitializeBuffer
*
* PARAMETERS: Buffer - Buffer to be validated
* RequiredLength - Length needed
*
* RETURN: Status
*
* DESCRIPTION: Validate that the buffer is of the required length or
* allocate a new buffer. Returned buffer is always zeroed.
*
******************************************************************************/
{
{
case ACPI_NO_BUFFER:
/* Set the exception and returned the required length */
break;
case ACPI_ALLOCATE_BUFFER:
/* Allocate a new buffer */
{
return (AE_NO_MEMORY);
}
/* Clear the buffer */
break;
/* Allocate a new buffer with local interface to allow tracking */
{
return (AE_NO_MEMORY);
}
break;
default:
/* Existing buffer: Validate the size of the buffer */
{
break;
}
/* Clear the buffer */
break;
}
return (Status);
}
/*******************************************************************************
*
* FUNCTION: AcpiUtAllocate
*
* PARAMETERS: Size - Size of the allocation
* Component - Component type of caller
* Module - Source file name of caller
* Line - Line number of caller
*
* RETURN: Address of the allocated memory on success, NULL on failure.
*
* DESCRIPTION: The subsystem's equivalent of malloc.
*
******************************************************************************/
void *
char *Module,
{
void *Allocation;
/* Check for an inadvertent size of zero bytes */
if (!Size)
{
("UtAllocate: Attempt to allocate zero bytes\n"));
Size = 1;
}
if (!Allocation)
{
/* Report allocation error */
return_PTR (NULL);
}
}
/*******************************************************************************
*
* FUNCTION: AcpiUtCallocate
*
* PARAMETERS: Size - Size of the allocation
* Component - Component type of caller
* Module - Source file name of caller
* Line - Line number of caller
*
* RETURN: Address of the allocated memory on success, NULL on failure.
*
* DESCRIPTION: Subsystem equivalent of calloc.
*
******************************************************************************/
void *
char *Module,
{
void *Allocation;
/* Check for an inadvertent size of zero bytes */
if (!Size)
{
("UtCallocate: Attempt to allocate zero bytes\n"));
return_PTR (NULL);
}
if (!Allocation)
{
/* Report allocation error */
return_PTR (NULL);
}
/* Clear the memory block */
}
#ifdef ACPI_DBG_TRACK_ALLOCATIONS
/*
* These procedures are used for tracking memory leaks in the subsystem, and
* they get compiled out when the ACPI_DBG_TRACK_ALLOCATIONS is not set.
*
* Each memory allocation is tracked via a doubly linked list. Each
* element contains the caller's component, module name, function name, and
* line number. AcpiUtAllocate and AcpiUtCallocate call
* AcpiUtTrackAllocation to add an element to the list; deletion
* occurs in the body of AcpiUtFree.
*/
/*******************************************************************************
*
* FUNCTION: AcpiUtCreateList
*
* PARAMETERS: CacheName - Ascii name for the cache
* ObjectSize - Size of each cached object
* ReturnCache - Where the new cache object is returned
*
* RETURN: Status
*
* DESCRIPTION: Create a local memory list for tracking purposed
*
******************************************************************************/
static ACPI_STATUS
char *ListName,
{
if (!Cache)
{
return (AE_NO_MEMORY);
}
*ReturnCache = Cache;
return (AE_OK);
}
/*******************************************************************************
*
* FUNCTION: AcpiUtAllocateAndTrack
*
* PARAMETERS: Size - Size of the allocation
* Component - Component type of caller
* Module - Source file name of caller
* Line - Line number of caller
*
* RETURN: Address of the allocated memory on success, NULL on failure.
*
* DESCRIPTION: The subsystem's equivalent of malloc.
*
******************************************************************************/
void *
char *Module,
{
if (!Allocation)
{
return (NULL);
}
if (ACPI_FAILURE (Status))
{
return (NULL);
}
return ((void *) &Allocation->UserSpace);
}
/*******************************************************************************
*
* FUNCTION: AcpiUtCallocateAndTrack
*
* PARAMETERS: Size - Size of the allocation
* Component - Component type of caller
* Module - Source file name of caller
* Line - Line number of caller
*
* RETURN: Address of the allocated memory on success, NULL on failure.
*
* DESCRIPTION: Subsystem equivalent of calloc.
*
******************************************************************************/
void *
char *Module,
{
if (!Allocation)
{
/* Report allocation error */
return (NULL);
}
if (ACPI_FAILURE (Status))
{
return (NULL);
}
return ((void *) &Allocation->UserSpace);
}
/*******************************************************************************
*
* FUNCTION: AcpiUtFreeAndTrack
*
* PARAMETERS: Allocation - Address of the memory to deallocate
* Component - Component type of caller
* Module - Source file name of caller
* Line - Line number of caller
*
* RETURN: None
*
* DESCRIPTION: Frees the memory at Allocation
*
******************************************************************************/
void
void *Allocation,
char *Module,
{
if (NULL == Allocation)
{
("AcpiUtFree: Attempt to delete a NULL address\n"));
}
(((char *) Allocation) - sizeof (ACPI_DEBUG_MEM_HEADER)));
if (ACPI_FAILURE (Status))
{
}
}
/*******************************************************************************
*
* FUNCTION: AcpiUtFindAllocation
*
* PARAMETERS: Allocation - Address of allocated memory
*
* RETURN: A list element if found; NULL otherwise.
*
* DESCRIPTION: Searches for an element in the global allocation tracking list.
*
******************************************************************************/
static ACPI_DEBUG_MEM_BLOCK *
void *Allocation)
{
/* Search for the address. */
while (Element)
{
if (Element == Allocation)
{
return (Element);
}
}
return (NULL);
}
/*******************************************************************************
*
* FUNCTION: AcpiUtTrackAllocation
*
* PARAMETERS: Allocation - Address of allocated memory
* Size - Size of the allocation
* AllocType - MEM_MALLOC or MEM_CALLOC
* Component - Component type of caller
* Module - Source file name of caller
* Line - Line number of caller
*
* RETURN: None.
*
* DESCRIPTION: Inserts an element into the global allocation tracking list.
*
******************************************************************************/
static ACPI_STATUS
char *Module,
{
if (ACPI_FAILURE (Status))
{
}
/*
* Search list for this address to make sure it is not already on the list.
* This will catch several kinds of problems.
*/
if (Element)
{
"UtTrackAllocation: Allocation already present in list! (%p)\n",
Allocation));
Element, Allocation));
goto UnlockAndExit;
}
/* Fill in the instance data. */
/* Insert at list head */
{
}
}
/*******************************************************************************
*
* FUNCTION: AcpiUtRemoveAllocation
*
* PARAMETERS: Allocation - Address of allocated memory
* Component - Component type of caller
* Module - Source file name of caller
* Line - Line number of caller
*
* RETURN:
*
* DESCRIPTION: Deletes an element from the global allocation tracking list.
*
******************************************************************************/
static ACPI_STATUS
char *Module,
{
ACPI_FUNCTION_TRACE ("UtRemoveAllocation");
{
/* No allocations! */
("UtRemoveAllocation: Empty allocation list, nothing to free!\n"));
}
if (ACPI_FAILURE (Status))
{
}
/* Unlink */
if (Allocation->Previous)
{
}
else
{
}
if (Allocation->Next)
{
}
/* Mark the segment as deleted */
Allocation->Size));
}
/*******************************************************************************
*
* FUNCTION: AcpiUtDumpAllocationInfo
*
* PARAMETERS:
*
* RETURN: None
*
* DESCRIPTION: Print some info about the outstanding allocations.
*
******************************************************************************/
void
void)
{
/*
ACPI_MEMORY_LIST *MemList;
*/
ACPI_FUNCTION_TRACE ("UtDumpAllocationInfo");
/*
ACPI_DEBUG_PRINT (TRACE_ALLOCATIONS | TRACE_TABLES,
("%30s: %4d (%3d Kb)\n", "Current allocations",
MemList->CurrentCount,
ROUND_UP_TO_1K (MemList->CurrentSize)));
ACPI_DEBUG_PRINT (TRACE_ALLOCATIONS | TRACE_TABLES,
("%30s: %4d (%3d Kb)\n", "Max concurrent allocations",
MemList->MaxConcurrentCount,
ROUND_UP_TO_1K (MemList->MaxConcurrentSize)));
ACPI_DEBUG_PRINT (TRACE_ALLOCATIONS | TRACE_TABLES,
("%30s: %4d (%3d Kb)\n", "Total (all) internal objects",
RunningObjectCount,
ROUND_UP_TO_1K (RunningObjectSize)));
ACPI_DEBUG_PRINT (TRACE_ALLOCATIONS | TRACE_TABLES,
("%30s: %4d (%3d Kb)\n", "Total (all) allocations",
RunningAllocCount,
ROUND_UP_TO_1K (RunningAllocSize)));
ACPI_DEBUG_PRINT (TRACE_ALLOCATIONS | TRACE_TABLES,
("%30s: %4d (%3d Kb)\n", "Current Nodes",
AcpiGbl_CurrentNodeCount,
ROUND_UP_TO_1K (AcpiGbl_CurrentNodeSize)));
ACPI_DEBUG_PRINT (TRACE_ALLOCATIONS | TRACE_TABLES,
("%30s: %4d (%3d Kb)\n", "Max Nodes",
AcpiGbl_MaxConcurrentNodeCount,
ROUND_UP_TO_1K ((AcpiGbl_MaxConcurrentNodeCount *
sizeof (ACPI_NAMESPACE_NODE)))));
*/
}
/*******************************************************************************
*
* FUNCTION: AcpiUtDumpAllocations
*
* PARAMETERS: Component - Component(s) to dump info for.
* Module - Module to dump info for. NULL means all.
*
* RETURN: None
*
* DESCRIPTION: Print a list of all outstanding allocations.
*
******************************************************************************/
void
char *Module)
{
UINT32 NumOutstanding = 0;
ACPI_FUNCTION_TRACE ("UtDumpAllocations");
/*
* Walk the allocation list.
*/
{
return;
}
while (Element)
{
{
/* Ignore allocated objects that are in a cache */
{
AcpiOsPrintf ("%p Len %04X %9.9s-%d [%s] ",
/* Most of the elements will be Operand objects. */
switch (ACPI_GET_DESCRIPTOR_TYPE (Descriptor))
{
case ACPI_DESC_TYPE_OPERAND:
AcpiOsPrintf ("%12.12s R%hd",
break;
case ACPI_DESC_TYPE_PARSER:
AcpiOsPrintf ("AmlOpcode %04hX",
break;
case ACPI_DESC_TYPE_NAMED:
AcpiOsPrintf ("%4.4s",
break;
default:
break;
}
AcpiOsPrintf ( "\n");
}
}
}
(void) AcpiUtReleaseMutex (ACPI_MTX_MEMORY);
/* Print summary */
if (!NumOutstanding)
{
"No outstanding allocations.\n"));
}
else
{
"%d(%X) Outstanding allocations\n",
}
}
#endif /* #ifdef ACPI_DBG_TRACK_ALLOCATIONS */