psparse.c revision 7c478bd95313f5f23a4c958a745db2134aa03244
/******************************************************************************
*
* Module Name: psparse - Parser top level AML parse routines
* $Revision: 152 $
*
*****************************************************************************/
/******************************************************************************
*
* 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.
*
*****************************************************************************/
/*
* Parse the AML and build an operation tree as most interpreters,
* like Perl, do. Parsing is done by hand rather than with a YACC
* generated parser to tightly constrain stack and dynamic memory
* usage. At the same time, parsing is kept flexible and the code
* fairly compact by parsing based on a list of AML opcode
* templates in AmlOpInfo[]
*/
#include "acpi.h"
#include "acparser.h"
#include "acdispat.h"
#include "amlcode.h"
#include "acnamesp.h"
#include "acinterp.h"
#define _COMPONENT ACPI_PARSER
ACPI_MODULE_NAME ("psparse")
static UINT32 AcpiGbl_Depth = 0;
/* Local prototypes */
static void
static ACPI_STATUS
static ACPI_STATUS
/*******************************************************************************
*
* FUNCTION: AcpiPsGetOpcodeSize
*
* PARAMETERS: Opcode - An AML opcode
*
* RETURN: Size of the opcode, in bytes (1 or 2)
*
* DESCRIPTION: Get the size of the current opcode.
*
******************************************************************************/
{
/* Extended (2-byte) opcode if > 255 */
if (Opcode > 0x00FF)
{
return (2);
}
/* Otherwise, just a single byte opcode */
return (1);
}
/*******************************************************************************
*
* FUNCTION: AcpiPsPeekOpcode
*
* PARAMETERS: ParserState - A parser state object
*
* RETURN: Next AML opcode
*
* DESCRIPTION: Get next AML opcode (without incrementing AML pointer)
*
******************************************************************************/
{
{
/* Extended opcode */
Aml++;
}
return (Opcode);
}
/*******************************************************************************
*
* FUNCTION: AcpiPsCompleteThisOp
*
* PARAMETERS: WalkState - Current State
* Op - Op to complete
*
* RETURN: None.
*
* DESCRIPTION: Perform any cleanup at the completion of an Op.
*
******************************************************************************/
static void
{
const ACPI_OPCODE_INFO *ParentInfo;
/* Check for null Op, can happen if AML code is corrupt */
if (!Op)
{
}
/* Delete this op and the subtree below it if asked to */
{
}
/* Make sure that we only delete this subtree */
{
/*
* Check if we need to replace the operator and its subtree
* with a return value op (placeholder op)
*/
switch (ParentInfo->Class)
{
case AML_CLASS_CONTROL:
break;
case AML_CLASS_CREATE:
/*
* These opcodes contain TermArg operands. The current
* op must be replaced by a placeholder return op
*/
if (!ReplacementOp)
{
goto Cleanup;
}
break;
case AML_CLASS_NAMED_OBJECT:
/*
* These opcodes contain TermArg operands. The current
* op must be replaced by a placeholder return op
*/
{
if (!ReplacementOp)
{
goto Cleanup;
}
}
{
{
if (!ReplacementOp)
{
goto Cleanup;
}
}
}
break;
default:
if (!ReplacementOp)
{
goto Cleanup;
}
}
/* We must unlink this op from the parent tree */
{
/* This op is the first in the list */
if (ReplacementOp)
{
}
else
{
}
}
/* Search the parent list */
else while (Prev)
{
/* Traverse all siblings in the parent's argument list */
{
if (ReplacementOp)
{
}
else
{
}
}
}
}
/* Now we can actually delete the subtree rooted at Op */
}
/*******************************************************************************
*
* FUNCTION: AcpiPsNextParseState
*
* PARAMETERS: WalkState - Current state
* Op - Current parse op
* CallbackStatus - Status from previous operation
*
* RETURN: Status
*
* DESCRIPTION: Update the parser state based upon the return exception from
* the parser callback.
*
******************************************************************************/
static ACPI_STATUS
{
switch (CallbackStatus)
{
case AE_CTRL_TERMINATE:
/*
* A control method was terminated via a RETURN statement.
* The walk of this method is complete.
*/
break;
case AE_CTRL_BREAK:
break;
case AE_CTRL_CONTINUE:
break;
case AE_CTRL_PENDING:
break;
#if 0
case AE_CTRL_SKIP:
break;
#endif
case AE_CTRL_TRUE:
/*
* Predicate of an IF was true, and we are at the matching ELSE.
* Just close out this package
*/
break;
case AE_CTRL_FALSE:
/*
* opcode. In both cases, we do not execute the rest of the
* package; We simply close out the parent (finishing the walk of
* this branch of the tree) and continue execution at the parent
* level.
*/
/* In the case of a BREAK, just force a predicate (if any) to FALSE */
break;
case AE_CTRL_TRANSFER:
/* A method call (invocation) -- transfer control */
/* Will return value (if any) be used by the caller? */
break;
default:
{
}
break;
}
}
/*******************************************************************************
*
* FUNCTION: AcpiPsParseLoop
*
* PARAMETERS: WalkState - Current state
*
* RETURN: Status
*
* DESCRIPTION: Parse AML (pointed to by the current parser state) and return
* a tree of ops.
*
******************************************************************************/
static ACPI_STATUS
{
{
}
#if (!defined (ACPI_NO_METHOD_EXECUTION) && !defined (ACPI_CONSTANT_EVAL_ONLY))
{
/* We are restarting a preempted control method */
{
/*
* We must check if a predicate to an IF or WHILE statement
* was just completed
*/
(WalkState->ControlState) &&
{
/*
* A predicate was just completed, get the value of the
* predicate and branch based on that value
*/
if (ACPI_FAILURE (Status) &&
{
if (Status == AE_AML_NO_RETURN_VALUE)
{
"Invoked method did not return a value, %s\n",
}
"GetPredicate Failed, %s\n",
}
}
}
{
/* We were in the middle of an op */
}
}
#endif
/* Iterative parsing loop, while there is more AML to process: */
{
if (!Op)
{
/* Get the next opcode from the AML stream */
/*
* First cut to determine what we have found:
* 1) A valid AML opcode
* 2) A name string
*/
{
case AML_CLASS_ASCII:
case AML_CLASS_PREFIX:
/*
* Starts with a valid prefix or ASCII char, this is a name
* string. Convert the bare name string to a namepath.
*/
break;
case AML_CLASS_UNKNOWN:
/* The opcode is unrecognized. Just skip unknown opcodes */
"Found unknown opcode %X at AML address %p offset %X, ignoring\n",
/* Assume one-byte bad opcode */
ParserState->Aml++;
continue;
default:
/* Found opcode info, this is a normal opcode */
break;
}
/* Create Op structure and append to parent's argument list */
{
/* Allocate a new PreOp if necessary */
if (!PreOp)
{
if (!PreOp)
{
goto CloseThisOp;
}
}
/*
* Get and append arguments until we find the node that contains
* the name (the type ARGP_NAME).
*/
{
if (ACPI_FAILURE (Status))
{
goto CloseThisOp;
}
}
/*
* Make sure that we found a NAME and didn't run out of
* arguments
*/
{
goto CloseThisOp;
}
/* We know that this arg is a name, move to next arg */
/*
* Find the object. This will either insert the object into
* the namespace or simply look it up
*/
if (ACPI_FAILURE (Status))
{
goto CloseThisOp;
}
if (!Op)
{
continue;
}
if (Status == AE_CTRL_PENDING)
{
goto CloseThisOp;
}
if (ACPI_FAILURE (Status))
{
goto CloseThisOp;
}
{
/*
* Defer final parsing of an OperationRegion body,
* because we don't have enough info in the first pass
* to parse it correctly (i.e., there may be method
* calls within the TermArg elements of the body.)
*
* However, we must continue parsing because
* the opregion is not a standalone package --
* we don't know where the end is at this point.
*
* (Length is unknown until parse of the body complete)
*/
}
}
else
{
/* Not a named opcode, just allocate Op and append to parent */
if (!Op)
{
goto CloseThisOp;
}
{
/*
* Backup to beginning of CreateXXXfield declaration
* BodyLength is unknown until we parse the body
*/
}
{
/*
* Find the object. This will either insert the object into
* the namespace or simply look it up
*/
if (Status == AE_CTRL_PENDING)
{
goto CloseThisOp;
}
if (ACPI_FAILURE (Status))
{
goto CloseThisOp;
}
}
}
{
"Opcode %4.4X [%s] Op %p Aml %p AmlOffset %5.5X\n",
}
}
/*
* Start ArgCount at zero because we don't know if there are
* any args yet
*/
/* Are there any arguments that must be processed? */
{
/* Get arguments */
{
case AML_BYTE_OP: /* AML_BYTEDATA_ARG */
case AML_WORD_OP: /* AML_WORDDATA_ARG */
case AML_DWORD_OP: /* AML_DWORDATA_ARG */
case AML_QWORD_OP: /* AML_QWORDATA_ARG */
case AML_STRING_OP: /* AML_ASCIICHARLIST_ARG */
/* Fill in constant or string argument directly */
break;
case AML_INT_NAMEPATH_OP: /* AML_NAMESTRING_ARG */
if (ACPI_FAILURE (Status))
{
goto CloseThisOp;
}
break;
default:
/*
* Op is not a constant or string, append each argument
* to the Op
*/
{
&Arg);
if (ACPI_FAILURE (Status))
{
goto CloseThisOp;
}
if (Arg)
{
}
}
/* Special processing for certain opcodes */
{
case AML_METHOD_OP:
/*
* Skip parsing of control method
* because we don't have enough info in the first pass
* to parse it correctly.
*
* Save the length and address of the body
*/
ParserState->Aml);
/* Skip body of method */
break;
case AML_BUFFER_OP:
case AML_PACKAGE_OP:
case AML_VAR_PACKAGE_OP:
{
/*
* Skip parsing of Buffers and Packages
* because we don't have enough info in the first pass
* to parse them correctly.
*/
/* Skip body */
}
break;
case AML_WHILE_OP:
if (WalkState->ControlState)
{
}
break;
default:
/* No action for all other opcodes */
break;
}
break;
}
}
/* Check for arguments that need to be processed */
{
/*
* There are arguments (complex ones), push Op and
* prepare for argument
*/
if (ACPI_FAILURE (Status))
{
goto CloseThisOp;
}
continue;
}
/*
* All arguments have been processed -- Op is complete,
* prepare for next
*/
{
if (AcpiGbl_Depth)
{
}
{
/*
* Skip parsing of control method or opregion body,
* because we don't have enough info in the first pass
* to parse them correctly.
*
* Completed parsing an OpRegion declaration, we now
* know the length.
*/
}
}
{
/*
* Backup to beginning of CreateXXXfield declaration (1 for
* Opcode)
*
* BodyLength is unknown until we parse the body
*/
}
/* This op complete, notify the dispatcher */
{
if (Status == AE_CTRL_PENDING)
{
goto CloseThisOp;
}
}
/*
* Finished one argument of the containing scope
*/
/* Close this Op (will result in parse subtree deletion) */
if (PreOp)
{
}
switch (Status)
{
case AE_OK:
break;
case AE_CTRL_TRANSFER:
/* We are about to transfer to a called method. */
case AE_CTRL_END:
if (Op)
{
}
break;
case AE_CTRL_BREAK:
case AE_CTRL_CONTINUE:
/* Pop off scopes until we find the While */
{
}
/* Close this iteration of the While loop */
break;
case AE_CTRL_TERMINATE:
/* Clean up */
do
{
if (Op)
{
}
} while (Op);
default: /* All other non-AE_OK status */
do
{
if (Op)
{
}
} while (Op);
/*
* TBD: Cleanup parse ops on error
*/
#if 0
{
}
#endif
}
/* This scope complete? */
{
}
else
{
}
} /* while ParserState->Aml */
/*
* Complete the last Op (if not completed), and clear the scope stack.
* It is easily possible to end an AML "package" with an unbounded number
* of open scopes (such as when several ASL blocks are closed with
* sequential closing braces). We want to terminate each one cleanly.
*/
do
{
if (Op)
{
{
if (Status == AE_CTRL_PENDING)
{
goto CloseThisOp;
}
if (Status == AE_CTRL_TERMINATE)
{
/* Clean up */
do
{
if (Op)
{
}
} while (Op);
}
else if (ACPI_FAILURE (Status))
{
}
}
}
} while (Op);
}
/*******************************************************************************
*
* FUNCTION: AcpiPsParseAml
*
* PARAMETERS: WalkState - Current state
*
*
* RETURN: Status
*
* DESCRIPTION: Parse raw AML and return a tree of ops
*
******************************************************************************/
{
ACPI_FUNCTION_TRACE ("PsParseAml");
"Entered with WalkState=%p Aml=%p size=%X\n",
/* Create and initialize a new thread state */
if (!Thread)
{
}
/*
* This global allows the AML debugger to get a handle to the currently
* executing control method.
*/
/*
* Execute the walk loop as long as there is a valid Walk State. This
* handles nested control method invocations without recursion.
*/
while (WalkState)
{
if (ACPI_SUCCESS (Status))
{
/*
* The ParseLoop executes AML until the method terminates
* or calls another method.
*/
}
"Completed one call to walk loop, %s State=%p\n",
if (Status == AE_CTRL_TRANSFER)
{
/*
* A method call was detected.
* Transfer control to the called control method
*/
/*
* If the transfer to the new method method call worked, a new walk
* state was created -- get it
*/
continue;
}
else if (Status == AE_CTRL_TERMINATE)
{
}
{
ACPI_REPORT_METHOD_ERROR ("Method execution failed",
/* Check for possible multi-thread reentrancy problem */
if ((Status == AE_ALREADY_EXISTS) &&
{
/*
* This method is marked NotSerialized, but it tried to create
* a named object, causing the second thread entrance to fail.
* We will workaround this by marking the method permanently
* as Serialized.
*/
}
}
if (WalkState->MethodDesc)
{
/* Decrement the thread count on the method parse tree */
{
}
}
/* We are done with this walk, move on to the parent if any */
/* Reset the current scope to the beginning of scope stack */
/*
* If we just returned from the execution of a control method,
* there's lots of cleanup to do
*/
{
if (ACPI_FAILURE (TerminateStatus))
{
"Could not terminate control method properly\n"));
/* Ignore error and continue */
}
}
/* Delete this walk state and all linked control states */
"ReturnValue=%p, ImplicitValue=%p State=%p\n",
/* Check if we have restarted a preempted walk */
if (WalkState)
{
if (ACPI_SUCCESS (Status))
{
/*
* There is another walk state, restart it.
* If the method return value is not used by the parent,
* The object is deleted
*/
if (!PreviousWalkState->ReturnDesc)
{
}
else
{
/*
* We have a valid return value, delete any implicit
* return value.
*/
}
if (ACPI_SUCCESS (Status))
{
}
}
else
{
/* On error, delete any return object */
}
}
/*
* Just completed a 1st-level method, save the final internal return
* value (if any)
*/
else if (PreviousWalkState->CallerReturnDesc)
{
{
}
else
{
/* NULL if no return value */
}
}
else
{
if (PreviousWalkState->ReturnDesc)
{
/* Caller doesn't want it, must delete it */
}
{
/* Caller doesn't want it, must delete it */
}
}
}
/* Normal exit */
}