dmwalk.c revision ae115bc77f6fcde83175c75b4206dc2e50747966
/*******************************************************************************
*
* Module Name: dmwalk - AML disassembly tree walk
* $Revision: 1.32 $
*
******************************************************************************/
/******************************************************************************
*
* 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.
*
*****************************************************************************/
#include "acpi.h"
#include "acparser.h"
#include "amlcode.h"
#include "acdisasm.h"
#include "acdebug.h"
#ifdef ACPI_DISASSEMBLER
#define _COMPONENT ACPI_CA_DEBUGGER
ACPI_MODULE_NAME ("dmwalk")
#define DB_FULL_OP_INFO "[%4.4s] @%5.5X #%4.4X: "
/* Local prototypes */
static ACPI_STATUS
void *Context);
static ACPI_STATUS
void *Context);
static UINT32
/*******************************************************************************
*
* FUNCTION: AcpiDmDisassemble
*
* PARAMETERS: WalkState - Current state
* Origin - Starting object
* NumOpcodes - Max number of opcodes to be displayed
*
* RETURN: None
*
* DESCRIPTION: Disassemble parser object and its children. This is the
* main entry point of the disassembler.
*
******************************************************************************/
void
{
if (!Op)
{
return;
}
return;
}
/*******************************************************************************
*
* FUNCTION: AcpiDmWalkParseTree
*
* PARAMETERS: Op - Root Op object
* DescendingCallback - Called during tree descent
* AscendingCallback - Called during tree ascent
* Context - To be passed to the callbacks
*
* RETURN: Status from callback(s)
*
* DESCRIPTION: Walk the entire parse tree.
*
******************************************************************************/
void
void *Context)
{
while (Op)
{
{
if (AscendingCallback)
{
if (ACPI_FAILURE (Status))
{
return;
}
}
}
else
{
/* Let the callback process the node */
if (ACPI_SUCCESS (Status))
{
/* Visit children first, once */
if (Next)
{
continue;
}
}
else if (Status != AE_CTRL_DEPTH)
{
/* Exit immediately on any error */
return;
}
}
/* Terminate walk at start op */
{
break;
}
/* No more children, re-visit this node */
if (!NodePreviouslyVisited)
{
continue;
}
/* No more children, visit peers */
{
}
else
{
/* No peers, re-visit parent */
{
}
}
}
/* If we get here, the walk completed with no errors */
return;
}
/*******************************************************************************
*
* FUNCTION: AcpiDmBlockType
*
* PARAMETERS: Op - Object to be examined
*
* RETURN: BlockType - not a block, parens, braces, or even both.
*
* DESCRIPTION: Type of block for this op (parens or braces)
*
******************************************************************************/
static UINT32
{
const ACPI_OPCODE_INFO *OpInfo;
if (!Op)
{
return (BLOCK_NONE);
}
{
case AML_ELSE_OP:
return (BLOCK_BRACE);
case AML_METHOD_OP:
case AML_DEVICE_OP:
case AML_SCOPE_OP:
case AML_PROCESSOR_OP:
case AML_POWER_RES_OP:
case AML_THERMAL_ZONE_OP:
case AML_IF_OP:
case AML_WHILE_OP:
case AML_FIELD_OP:
case AML_INDEX_FIELD_OP:
case AML_BANK_FIELD_OP:
return (BLOCK_PAREN | BLOCK_BRACE);
case AML_BUFFER_OP:
{
return (BLOCK_NONE);
}
/*lint -fallthrough */
case AML_PACKAGE_OP:
case AML_VAR_PACKAGE_OP:
return (BLOCK_PAREN | BLOCK_BRACE);
case AML_EVENT_OP:
return (BLOCK_PAREN);
default:
{
return (BLOCK_PAREN);
}
return (BLOCK_NONE);
}
}
/*******************************************************************************
*
* FUNCTION: AcpiDmListType
*
* PARAMETERS: Op - Object to be examined
*
* RETURN: ListType - has commas or not.
*
* DESCRIPTION: Type of block for this op (parens or braces)
*
******************************************************************************/
{
const ACPI_OPCODE_INFO *OpInfo;
if (!Op)
{
return (BLOCK_NONE);
}
{
case AML_ELSE_OP:
case AML_METHOD_OP:
case AML_DEVICE_OP:
case AML_SCOPE_OP:
case AML_POWER_RES_OP:
case AML_PROCESSOR_OP:
case AML_THERMAL_ZONE_OP:
case AML_IF_OP:
case AML_WHILE_OP:
case AML_FIELD_OP:
case AML_INDEX_FIELD_OP:
case AML_BANK_FIELD_OP:
return (BLOCK_NONE);
case AML_BUFFER_OP:
case AML_PACKAGE_OP:
case AML_VAR_PACKAGE_OP:
return (BLOCK_COMMA_LIST);
default:
{
return (BLOCK_COMMA_LIST);
}
return (BLOCK_NONE);
}
}
/*******************************************************************************
*
* FUNCTION: AcpiDmDescendingOp
*
* PARAMETERS: ASL_WALK_CALLBACK
*
* RETURN: Status
*
* DESCRIPTION: First visitation of a parse object during tree descent.
* Decode opcode name and begin parameter list(s), if any.
*
******************************************************************************/
static ACPI_STATUS
void *Context)
{
const ACPI_OPCODE_INFO *OpInfo;
{
/* Ignore this op -- it was handled elsewhere */
return (AE_CTRL_DEPTH);
}
/* Level 0 is at the Definition Block level */
if (Level == 0)
{
/* In verbose mode, print the AML offset, opcode and depth count */
{
}
{
/* This is the beginning of the Definition Block */
AcpiOsPrintf ("{\n");
/* Emit all External() declarations here */
if (AcpiGbl_ExternalList)
{
/*
* Walk the list of externals (unresolved references)
* found during parsing
*/
while (AcpiGbl_ExternalList)
{
AcpiOsPrintf (" External (%s",
/* TBD: should be a lookup table */
switch (AcpiGbl_ExternalList->Type)
{
case ACPI_TYPE_DEVICE:
AcpiOsPrintf (", DeviceObj");
break;
case ACPI_TYPE_METHOD:
AcpiOsPrintf (", MethodObj");
break;
case ACPI_TYPE_INTEGER:
AcpiOsPrintf (", IntObj");
break;
default:
break;
}
{
}
else
{
AcpiOsPrintf (")\n");
}
}
AcpiOsPrintf ("\n");
}
return (AE_OK);
}
}
{
/*
* This is a first-level element of a term list,
* indent a new line
*/
}
/*
* This is an inexpensive mechanism to try and keep lines from getting
* too long. When the limit is hit, start a new line at the previous
* indent plus one. A better but more expensive mechanism would be to
* keep track of the current column.
*/
{
AcpiOsPrintf ("\n");
}
/* Print the opcode name */
{
return (AE_OK);
}
{
}
/* Start the opcode argument list if necessary */
{
/* This opcode has an argument list */
{
AcpiOsPrintf (" (");
}
/* If this is a named opcode, print the associated name value */
{
{
case AML_ALIAS_OP:
AcpiOsPrintf (", ");
/*lint -fallthrough */
default:
{
}
else
{
AcpiDmDumpName ((char *) &Name);
}
{
{
}
}
break;
}
{
case AML_METHOD_OP:
AcpiOsPrintf (")");
break;
case AML_NAME_OP:
/* Check for _HID and related EISAID() */
AcpiDmIsEisaId (Op);
AcpiOsPrintf (", ");
break;
case AML_REGION_OP:
break;
case AML_POWER_RES_OP:
/* Mark the next two Ops as part of the parameter list */
AcpiOsPrintf (", ");
return (AE_OK);
case AML_PROCESSOR_OP:
/* Mark the next three Ops as part of the parameter list */
AcpiOsPrintf (", ");
return (AE_OK);
case AML_MUTEX_OP:
case AML_DATA_REGION_OP:
AcpiOsPrintf (", ");
return (AE_OK);
case AML_EVENT_OP:
case AML_ALIAS_OP:
return (AE_OK);
case AML_SCOPE_OP:
case AML_DEVICE_OP:
case AML_THERMAL_ZONE_OP:
AcpiOsPrintf (")");
break;
default:
break;
}
}
{
case AML_FIELD_OP:
case AML_BANK_FIELD_OP:
case AML_INDEX_FIELD_OP:
/* Name of the parent OperationRegion */
AcpiOsPrintf (", ");
{
case AML_BANK_FIELD_OP:
/* Namestring - Bank Name */
AcpiOsPrintf (", ");
/*
* Bank Value. This is a TermArg in the middle of the parameter
* list, must handle it here.
*
* Disassemble the TermArg parse tree. ACPI_PARSEOP_PARAMLIST
* eliminates newline in the output.
*/
AcpiOsPrintf (", ");
break;
case AML_INDEX_FIELD_OP:
/* Namestring - Data Name */
AcpiOsPrintf (", ");
break;
default:
break;
}
break;
case AML_BUFFER_OP:
/* The next op is the size parameter */
if (!NextOp)
{
/* Single-step support */
return (AE_OK);
}
{
/*
* We have a resource list. Don't need to output
* the buffer size Op. Open up a new block
*/
AcpiOsPrintf (")\n");
AcpiOsPrintf ("{\n");
return (AE_OK);
}
/* Normal Buffer, mark size as in the parameter list */
return (AE_OK);
case AML_VAR_PACKAGE_OP:
case AML_IF_OP:
case AML_WHILE_OP:
/* The next op is the size or predicate parameter */
if (NextOp)
{
}
return (AE_OK);
case AML_PACKAGE_OP:
/* The next op is the size or predicate parameter */
if (NextOp)
{
}
return (AE_OK);
case AML_MATCH_OP:
AcpiDmMatchOp (Op);
break;
default:
break;
}
{
AcpiOsPrintf ("\n");
AcpiOsPrintf ("{\n");
}
}
return (AE_OK);
}
/*******************************************************************************
*
* FUNCTION: AcpiDmAscendingOp
*
* PARAMETERS: ASL_WALK_CALLBACK
*
* RETURN: Status
*
* DESCRIPTION: Second visitation of a parse object, during ascent of parse
* tree. Close out any parameter lists and complete the opcode.
*
******************************************************************************/
static ACPI_STATUS
void *Context)
{
{
/* Ignore this op -- it was handled elsewhere */
return (AE_OK);
}
{
/* Indicates the end of the current descriptor block (table) */
AcpiOsPrintf ("}\n\n");
return (AE_OK);
}
switch (AcpiDmBlockType (Op))
{
case BLOCK_PAREN:
/* Completed an op that has arguments, add closing paren */
AcpiOsPrintf (")");
/* Could be a nested operator, check if comma required */
if (!AcpiDmCommaIfListMember (Op))
{
{
/*
* This is a first-level element of a term list
* start a new line
*/
{
AcpiOsPrintf ("\n");
}
}
}
break;
case BLOCK_BRACE:
case (BLOCK_BRACE | BLOCK_PAREN):
/* Completed an op that has a term list, add closing brace */
{
AcpiOsPrintf ("}");
}
else
{
AcpiOsPrintf ("}");
}
{
AcpiOsPrintf ("\n");
{
{
break;
}
{
break;
}
AcpiOsPrintf ("\n");
}
}
break;
case BLOCK_NONE:
default:
/* Could be a nested operator, check if comma required */
if (!AcpiDmCommaIfListMember (Op))
{
{
/*
* This is a first-level element of a term list
* start a new line
*/
AcpiOsPrintf ("\n");
}
}
{
{
case AML_PACKAGE_OP:
case AML_VAR_PACKAGE_OP:
{
AcpiOsPrintf ("\n");
}
break;
default:
break;
}
}
break;
}
{
{
return (AE_OK);
}
/*
* Just completed a parameter node for something like "Buffer (param)".
* Close the paren and open up the term list block with a brace
*/
{
AcpiOsPrintf (")\n");
AcpiOsPrintf ("{\n");
}
else
{
AcpiOsPrintf (") {");
}
}
{
}
return (AE_OK);
}
#endif /* ACPI_DISASSEMBLER */