dswstate.c revision 27f7c58306b55fe9e0cfd2934039be1729b505e9
/******************************************************************************
*
* Module Name: dswstate - Dispatcher parse tree walk management routines
* $Revision: 1.98 $
*
*****************************************************************************/
/******************************************************************************
*
* 1. Copyright Notice
*
* Some or all of this work - Copyright (c) 1999 - 2006, 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 __DSWSTATE_C__
#include "acpi.h"
#include "acparser.h"
#include "acdispat.h"
#include "acnamesp.h"
#define _COMPONENT ACPI_DISPATCHER
ACPI_MODULE_NAME ("dswstate")
/* Local prototypes */
#ifdef ACPI_OBSOLETE_FUNCTIONS
void *Object,
void *
#endif
/*******************************************************************************
*
* FUNCTION: AcpiDsResultRemove
*
* PARAMETERS: Object - Where to return the popped object
* Index - Where to extract the object
* WalkState - Current Walk state
*
* RETURN: Status
*
* DESCRIPTION: Pop an object off the bottom of this walk's result stack. In
* other words, this is a FIFO.
*
******************************************************************************/
{
if (!State)
{
WalkState));
return (AE_NOT_EXIST);
}
if (Index >= ACPI_OBJ_MAX_OPERAND)
{
"Index out of range: %X State=%p Num=%X",
}
/* Check for a valid result object */
{
"Null operand! State=%p #Ops=%X, Index=%X",
return (AE_AML_NO_RETURN_VALUE);
}
/* Remove the object */
"Obj=%p [%s] Index=%X State=%p Num=%X\n",
return (AE_OK);
}
/*******************************************************************************
*
* FUNCTION: AcpiDsResultPop
*
* PARAMETERS: Object - Where to return the popped object
* WalkState - Current Walk state
*
* RETURN: Status
*
* DESCRIPTION: Pop an object off the bottom of this walk's result stack. In
* other words, this is a FIFO.
*
******************************************************************************/
{
if (!State)
{
return (AE_OK);
}
{
WalkState));
return (AE_AML_NO_RETURN_VALUE);
}
/* Remove top element */
{
/* Check for a valid result object */
{
"Obj=%p [%s] Index=%X State=%p Num=%X\n",
*Object,
return (AE_OK);
}
}
"No result objects! State=%p", WalkState));
return (AE_AML_NO_RETURN_VALUE);
}
/*******************************************************************************
*
* FUNCTION: AcpiDsResultPopFromBottom
*
* PARAMETERS: Object - Where to return the popped object
* WalkState - Current Walk state
*
* RETURN: Status
*
* DESCRIPTION: Pop an object off the bottom of this walk's result stack. In
* other words, this is a FIFO.
*
******************************************************************************/
{
if (!State)
{
"No result object pushed! State=%p", WalkState));
return (AE_NOT_EXIST);
}
{
WalkState));
return (AE_AML_NO_RETURN_VALUE);
}
/* Remove Bottom element */
/* Push entire stack down one element */
{
}
/* Check for a valid result object */
if (!*Object)
{
"Null operand! State=%p #Ops=%X Index=%X",
return (AE_AML_NO_RETURN_VALUE);
}
return (AE_OK);
}
/*******************************************************************************
*
* FUNCTION: AcpiDsResultPush
*
* PARAMETERS: Object - Where to return the popped object
* WalkState - Current Walk state
*
* RETURN: Status
*
* DESCRIPTION: Push an object onto the current result stack
*
******************************************************************************/
{
if (!State)
{
return (AE_AML_INTERNAL);
}
{
"Result stack overflow: Obj=%p State=%p Num=%X",
return (AE_STACK_OVERFLOW);
}
if (!Object)
{
"Null Object! Obj=%p State=%p Num=%X",
return (AE_BAD_PARAMETER);
}
return (AE_OK);
}
/*******************************************************************************
*
* FUNCTION: AcpiDsResultStackPush
*
* PARAMETERS: WalkState - Current Walk state
*
* RETURN: Status
*
* DESCRIPTION: Push an object onto the WalkState result stack.
*
******************************************************************************/
{
if (!State)
{
return (AE_NO_MEMORY);
}
return (AE_OK);
}
/*******************************************************************************
*
* FUNCTION: AcpiDsResultStackPop
*
* PARAMETERS: WalkState - Current Walk state
*
* RETURN: Status
*
* DESCRIPTION: Pop an object off of the WalkState result stack.
*
******************************************************************************/
{
/* Check for stack underflow */
{
WalkState));
return (AE_AML_NO_OPERAND);
}
"Result=%p RemainingResults=%X State=%p\n",
return (AE_OK);
}
/*******************************************************************************
*
* FUNCTION: AcpiDsObjStackPush
*
* PARAMETERS: Object - Object to push
* WalkState - Current Walk state
*
* RETURN: Status
*
*
******************************************************************************/
void *Object,
{
/* Check for stack overflow */
{
"Object stack overflow! Obj=%p State=%p #Ops=%X",
return (AE_STACK_OVERFLOW);
}
/* Put the object onto the stack */
WalkState->NumOperands++;
return (AE_OK);
}
/*******************************************************************************
*
* FUNCTION: AcpiDsObjStackPop
*
* WalkState - Current Walk state
*
* RETURN: Status
*
* DESCRIPTION: Pop this walk's object stack. Objects on the stack are NOT
* deleted by this routine.
*
******************************************************************************/
{
UINT32 i;
for (i = 0; i < PopCount; i++)
{
/* Check for stack underflow */
if (WalkState->NumOperands == 0)
{
"Object stack underflow! Count=%X State=%p #Ops=%X",
return (AE_STACK_UNDERFLOW);
}
/* Just set the stack entry to null */
WalkState->NumOperands--;
}
return (AE_OK);
}
/*******************************************************************************
*
* FUNCTION: AcpiDsObjStackPopAndDelete
*
* WalkState - Current Walk state
*
* RETURN: Status
*
* DESCRIPTION: Pop this walk's object stack and delete each object that is
* popped off.
*
******************************************************************************/
{
UINT32 i;
for (i = 0; i < PopCount; i++)
{
/* Check for stack underflow */
if (WalkState->NumOperands == 0)
{
"Object stack underflow! Count=%X State=%p #Ops=%X",
return (AE_STACK_UNDERFLOW);
}
/* Pop the stack and delete an object if present in this stack entry */
WalkState->NumOperands--;
if (ObjDesc)
{
}
}
return (AE_OK);
}
/*******************************************************************************
*
* FUNCTION: AcpiDsGetCurrentWalkState
*
* PARAMETERS: Thread - Get current active state for this Thread
*
* RETURN: Pointer to the current walk state
*
* DESCRIPTION: Get the walk state that is at the head of the list (the "current"
* walk state.)
*
******************************************************************************/
{
if (!Thread)
{
return (NULL);
}
Thread->WalkStateList));
return (Thread->WalkStateList);
}
/*******************************************************************************
*
* FUNCTION: AcpiDsPushWalkState
*
* PARAMETERS: WalkState - State to push
* Thread - Thread state object
*
* RETURN: None
*
* DESCRIPTION: Place the Thread state at the head of the state list.
*
******************************************************************************/
void
{
}
/*******************************************************************************
*
* FUNCTION: AcpiDsPopWalkState
*
* PARAMETERS: Thread - Current thread state
*
* RETURN: A WalkState object popped from the thread's stack
*
* DESCRIPTION: Remove and return the walkstate object that is at the head of
* the walk stack for the given walk list. NULL indicates that
* the list is empty.
*
******************************************************************************/
{
if (WalkState)
{
/* Next walk state becomes the current walk state */
/*
* Don't clear the NEXT field, this serves as an indicator
* that there is a parent WALK STATE
* Do Not: WalkState->Next = NULL;
*/
}
}
/*******************************************************************************
*
* FUNCTION: AcpiDsCreateWalkState
*
* PARAMETERS: OwnerId - ID for object creation
* Origin - Starting point for this walk
* MethodDesc - Method object
* Thread - Current thread state
*
* RETURN: Pointer to the new walk state.
*
* DESCRIPTION: Allocate and initialize a new walk state. The current walk
* state is set to this new state.
*
******************************************************************************/
{
if (!WalkState)
{
return_PTR (NULL);
}
#if (!defined (ACPI_NO_METHOD_EXECUTION) && !defined (ACPI_CONSTANT_EVAL_ONLY))
#endif
/* Create an initial result stack entry */
if (ACPI_FAILURE (Status))
{
return_PTR (NULL);
}
/* Put the new state at the head of the walk list */
if (Thread)
{
}
}
/*******************************************************************************
*
* FUNCTION: AcpiDsInitAmlWalk
*
* PARAMETERS: WalkState - New state to be initialized
* Op - Current parse op
* MethodNode - Control method NS node, if any
* AmlStart - Start of AML
* AmlLength - Length of AML
* Info - Method info block (params, etc.)
* PassNumber - 1, 2, or 3
*
* RETURN: Status
*
* DESCRIPTION: Initialize a walk state for a pass 1 or 2 parse tree walk
*
******************************************************************************/
{
/* The NextOp of the NextWalk will be the beginning of the method */
if (Info)
{
{
}
else
{
}
}
if (ACPI_FAILURE (Status))
{
}
if (MethodNode)
{
/* Push start scope on scope stack and make it current */
if (ACPI_FAILURE (Status))
{
}
/* Init the method arguments */
if (ACPI_FAILURE (Status))
{
}
}
else
{
/*
* Setup the current scope.
* Find a Named Op that has a namespace node associated with it.
* search upwards from this Op. Current scope is the first
* Op with a namespace node.
*/
{
}
if (!ExtraOp)
{
}
else
{
}
if (ParserState->StartNode)
{
/* Push start scope on scope stack and make it current */
if (ACPI_FAILURE (Status))
{
}
}
}
}
/*******************************************************************************
*
* FUNCTION: AcpiDsDeleteWalkState
*
* PARAMETERS: WalkState - State to delete
*
* RETURN: Status
*
* DESCRIPTION: Delete a walk state including all internal data structures
*
******************************************************************************/
void
{
if (!WalkState)
{
return;
}
{
WalkState));
return;
}
/* There should not be any open scopes */
{
WalkState));
}
/* Always must free any linked control states */
while (WalkState->ControlState)
{
}
/* Always must free any linked parse states */
{
}
/* Always must free any stacked result states */
{
}
}
#ifdef ACPI_OBSOLETE_FUNCTIONS
/*******************************************************************************
*
* FUNCTION: AcpiDsResultInsert
*
* PARAMETERS: Object - Object to push
* Index - Where to insert the object
* WalkState - Current Walk state
*
* RETURN: Status
*
* DESCRIPTION: Insert an object onto this walk's result stack
*
******************************************************************************/
void *Object,
{
if (!State)
{
WalkState));
return (AE_NOT_EXIST);
}
if (Index >= ACPI_OBJ_NUM_OPERANDS)
{
"Index out of range: %X Obj=%p State=%p Num=%X",
return (AE_BAD_PARAMETER);
}
if (!Object)
{
"Null Object! Index=%X Obj=%p State=%p Num=%X",
return (AE_BAD_PARAMETER);
}
"Obj=%p [%s] State=%p Num=%X Cur=%X\n",
return (AE_OK);
}
/*******************************************************************************
*
* FUNCTION: AcpiDsObjStackDeleteAll
*
* PARAMETERS: WalkState - Current Walk state
*
* RETURN: Status
*
* DESCRIPTION: Clear the object stack by deleting all objects that are on it.
* Should be used with great care, if at all!
*
******************************************************************************/
{
UINT32 i;
/* The stack size is configurable, but fixed */
for (i = 0; i < ACPI_OBJ_NUM_OPERANDS; i++)
{
{
}
}
}
/*******************************************************************************
*
* FUNCTION: AcpiDsObjStackPopObject
*
* PARAMETERS: Object - Where to return the popped object
* WalkState - Current Walk state
*
* RETURN: Status
*
* DESCRIPTION: Pop this walk's object stack. Objects on the stack are NOT
* deleted by this routine.
*
******************************************************************************/
{
/* Check for stack underflow */
if (WalkState->NumOperands == 0)
{
return (AE_AML_NO_OPERAND);
}
/* Pop the stack */
WalkState->NumOperands--;
/* Check for a valid operand */
{
"Null operand! State=%p #Ops=%X",
return (AE_AML_NO_OPERAND);
}
/* Get operand and set stack entry to null */
return (AE_OK);
}
/*******************************************************************************
*
* FUNCTION: AcpiDsObjStackGetValue
*
* PARAMETERS: Index - Stack index whose value is desired. Based
* on the top of the stack (index=0 == top)
* WalkState - Current Walk state
*
* RETURN: Pointer to the requested operand
*
* DESCRIPTION: Retrieve an object from this walk's operand stack. Index must
* be within the range of the current stack pointer.
*
******************************************************************************/
void *
{
/* Can't do it if the stack is empty */
if (WalkState->NumOperands == 0)
{
return_PTR (NULL);
}
/* or if the index is past the top of the stack */
{
return_PTR (NULL);
}
Index]);
}
#endif