utdelete.c revision 7c478bd95313f5f23a4c958a745db2134aa03244
/*******************************************************************************
*
* Module Name: utdelete - object deletion and reference count utilities
* $Revision: 105 $
*
******************************************************************************/
/******************************************************************************
*
* 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 __UTDELETE_C__
#include "acpi.h"
#include "acinterp.h"
#include "acnamesp.h"
#include "acevents.h"
#include "amlcode.h"
#define _COMPONENT ACPI_UTILITIES
ACPI_MODULE_NAME ("utdelete")
/* Local prototypes */
static void
static void
/*******************************************************************************
*
* FUNCTION: AcpiUtDeleteInternalObj
*
* PARAMETERS: Object - Object to be deleted
*
* RETURN: None
*
* DESCRIPTION: Low level object deletion, after reference counts have been
* updated (All reference counts, including sub-objects!)
*
******************************************************************************/
static void
{
void *ObjPointer = NULL;
if (!Object)
{
}
/*
* Must delete or free any pointers within the object that are not
* actual ACPI objects (for example, a raw buffer pointer).
*/
switch (ACPI_GET_OBJECT_TYPE (Object))
{
case ACPI_TYPE_STRING:
/* Free the actual string buffer */
{
/* But only if it is NOT a pointer into an ACPI table */
}
break;
case ACPI_TYPE_BUFFER:
/* Free the actual buffer */
{
/* But only if it is NOT a pointer into an ACPI table */
}
break;
case ACPI_TYPE_PACKAGE:
/*
* Elements of the package are not handled here, they are deleted
* separately
*/
/* Free the (variable length) element pointer array */
break;
case ACPI_TYPE_DEVICE:
{
}
/* Walk the handler list for this device */
while (HandlerDesc)
{
}
break;
case ACPI_TYPE_MUTEX:
"***** Mutex %p, Semaphore %p\n",
break;
case ACPI_TYPE_EVENT:
"***** Event %p, Semaphore %p\n",
break;
case ACPI_TYPE_METHOD:
"***** Method %p\n", Object));
/* Delete the method semaphore if it exists */
{
}
break;
case ACPI_TYPE_REGION:
"***** Region %p\n", Object));
if (SecondDesc)
{
/*
* Free the RegionContext if and only if the handler is one of the
* default handlers -- and therefore, we created the context object
* locally, it was not created by an external caller.
*/
if (HandlerDesc)
{
{
}
}
/* Now we can free the Extra object */
}
break;
case ACPI_TYPE_BUFFER_FIELD:
"***** Buffer Field %p\n", Object));
if (SecondDesc)
{
}
break;
default:
break;
}
/* Free any allocated memory (pointer within the object) found above */
if (ObjPointer)
{
ObjPointer));
}
/* Now the object can be safely deleted */
}
/*******************************************************************************
*
* FUNCTION: AcpiUtDeleteInternalObjectList
*
* PARAMETERS: ObjList - Pointer to the list to be deleted
*
* RETURN: None
*
* DESCRIPTION: This function deletes an internal object list, including both
* simple objects and package objects
*
******************************************************************************/
void
{
ACPI_FUNCTION_TRACE ("UtDeleteInternalObjectList");
/* Walk the null-terminated internal list */
{
}
/* Free the combined parameter pointer list and object array */
}
/*******************************************************************************
*
* FUNCTION: AcpiUtUpdateRefCount
*
* PARAMETERS: Object - Object whose ref count is to be updated
* Action - What to do
*
* RETURN: New ref count
*
* DESCRIPTION: Modify the ref count and return it.
*
******************************************************************************/
static void
{
ACPI_FUNCTION_NAME ("UtUpdateRefCount");
if (!Object)
{
return;
}
/*
* Perform the reference count action
* (increment, decrement, or force delete)
*/
switch (Action)
{
case REF_INCREMENT:
NewCount++;
"Obj %p Refs=%X, [Incremented]\n",
break;
case REF_DECREMENT:
if (Count < 1)
{
"Obj %p Refs=%X, can't decrement! (Set to 0)\n",
NewCount = 0;
}
else
{
NewCount--;
"Obj %p Refs=%X, [Decremented]\n",
}
{
"Method Obj %p Refs=%X, [Decremented]\n",
}
if (NewCount == 0)
{
}
break;
case REF_FORCE_DELETE:
"Obj %p Refs=%X, Force delete! (Set to 0)\n",
NewCount = 0;
break;
default:
break;
}
/*
* Sanity check the reference count, for debug purposes only.
* (A deleted object will have a huge reference count)
*/
if (Count > ACPI_MAX_REFERENCE_COUNT)
{
"**** Warning **** Large Reference Count (%X) in object %p\n\n",
}
return;
}
/*******************************************************************************
*
* FUNCTION: AcpiUtUpdateObjectReference
*
* PARAMETERS: Object - Increment ref count for this object
* and all sub-objects
* Action - Either REF_INCREMENT or REF_DECREMENT or
* REF_FORCE_DELETE
*
* RETURN: Status
*
* DESCRIPTION: Increment the object reference count
*
* Object references are incremented when:
* 1) An object is attached to a Node (namespace object)
* 2) An object is copied (all subobjects must be incremented)
*
* Object references are decremented when:
* 1) An object is detached from an Node
*
******************************************************************************/
{
UINT32 i;
/* Ignore a null object ptr */
if (!Object)
{
}
/* Make sure that this isn't a namespace handle */
{
"Object %p is NS handle\n", Object));
}
while (State)
{
/*
* All sub-objects must have their reference count incremented also.
* Different object types have different subobjects.
*/
switch (ACPI_GET_OBJECT_TYPE (Object))
{
case ACPI_TYPE_DEVICE:
break;
case ACPI_TYPE_PACKAGE:
/*
* We must update all the sub-objects of the package
* (Each of whom may have their own sub-objects, etc.
*/
{
/*
* Push each element onto the stack for later processing.
* Note: There can be null elements within the package,
* these are simply ignored
*/
if (ACPI_FAILURE (Status))
{
goto ErrorExit;
}
}
break;
case ACPI_TYPE_BUFFER_FIELD:
if (ACPI_FAILURE (Status))
{
goto ErrorExit;
}
break;
if (ACPI_FAILURE (Status))
{
goto ErrorExit;
}
break;
if (ACPI_FAILURE (Status))
{
goto ErrorExit;
}
if (ACPI_FAILURE (Status))
{
goto ErrorExit;
}
break;
if (ACPI_FAILURE (Status))
{
goto ErrorExit;
}
if (ACPI_FAILURE (Status))
{
goto ErrorExit;
}
break;
/*
* The target of an Index (a package, string, or buffer) must track
* changes to the ref count of the index.
*/
{
if (ACPI_FAILURE (Status))
{
goto ErrorExit;
}
}
break;
case ACPI_TYPE_REGION:
default:
/* No subobjects */
break;
}
/*
* Now we can update the count in the main object. This can only
* happen after we update the sub-objects in case this causes the
* main object to be deleted.
*/
/* Move on to the next object to be updated */
}
ACPI_REPORT_ERROR (("Could not update object reference count, %s\n",
}
/*******************************************************************************
*
* FUNCTION: AcpiUtAddReference
*
* PARAMETERS: Object - Object whose reference count is to be
* incremented
*
* RETURN: None
*
* DESCRIPTION: Add one reference to an ACPI object
*
******************************************************************************/
void
{
/* Ensure that we have a valid object */
if (!AcpiUtValidInternalObject (Object))
{
}
"Obj %p Current Refs=%X [To Be Incremented]\n",
/* Increment the reference count */
}
/*******************************************************************************
*
* FUNCTION: AcpiUtRemoveReference
*
* PARAMETERS: Object - Object whose ref count will be decremented
*
* RETURN: None
*
* DESCRIPTION: Decrement the reference count of an ACPI internal object
*
******************************************************************************/
void
{
/*
* Allow a NULL pointer to be passed in, just ignore it. This saves
* each caller from having to check. Also, ignore NS nodes.
*
*/
if (!Object ||
{
}
/* Ensure that we have a valid object */
if (!AcpiUtValidInternalObject (Object))
{
}
"Obj %p Current Refs=%X [To Be Decremented]\n",
/*
* Decrement the reference count, and only actually delete the object
* if the reference count becomes 0. (Must also decrement the ref count
* of all subobjects!)
*/
}