aystarik 51d47f2b14 NTE display bug fixed
date	2000.05.03.20.07.00;	author rmoore1;	state Exp;
2005-06-29 16:18:14 +00:00

849 lines
24 KiB
C

/******************************************************************************
*
* Module Name: dbdisply - debug display commands
*
*****************************************************************************/
/******************************************************************************
*
* 1. Copyright Notice
*
* Some or all of this work - Copyright (c) 1999, 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
* documentation and/or other materials provided with distribution. In
* 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
* provision in the documentation and/or other materials provided with the
* 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
* ensure that the distribution and export/re-export of the software is in
* compliance with all laws, regulations, orders, or other restrictions of the
* U.S. Export Administration Regulations. Licensee agrees that neither it nor
* any of its subsidiaries will export/re-export any technical data, process,
* 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 <parser.h>
#include <amlcode.h>
#include <dispatch.h>
#include <namesp.h>
#include <parser.h>
#include <events.h>
#include <interp.h>
#include <debugger.h>
#ifdef ACPI_DEBUG
#define _COMPONENT DEBUGGER
MODULE_NAME ("dbdisply");
/******************************************************************************
*
* FUNCTION: DbDumpParserDescriptor
*
* PARAMETERS: Op - A parser Op descriptor
*
* RETURN: None
*
* DESCRIPTION: Display a formatted parser object
*
*****************************************************************************/
void
DbDumpParserDescriptor (
ACPI_GENERIC_OP *Op)
{
ACPI_OP_INFO *Info;
Info = PsGetOpcodeInfo (Op->Opcode);
OsdPrintf ("Parser Op Descriptor:\n");
OsdPrintf ("%20.20s : %4.4X\n", "Opcode", Op->Opcode);
OsdPrintf ("%20.20s : %s\n", "Opcode Name", Info->Name);
OsdPrintf ("%20.20s : %p\n", "Value/ArgList", Op->Value);
OsdPrintf ("%20.20s : %p\n", "Parent", Op->Parent);
OsdPrintf ("%20.20s : %p\n", "NextOp", Op->Next);
}
/******************************************************************************
*
* FUNCTION: DbDecodeAndDisplayObject
*
* PARAMETERS:
*
* RETURN: None
*
* DESCRIPTION: Display a formatted ACPI object
*
*****************************************************************************/
void
DbDecodeAndDisplayObject (
char *Target,
char *OutputType)
{
void *ObjPtr;
NAME_TABLE_ENTRY *Entry;
UINT32 Display = DB_BYTE_DISPLAY;
char Buffer[80];
ACPI_BUFFER RetBuf;
ACPI_STATUS Status;
UINT32 Size;
if (!Target)
{
return;
}
if (OutputType)
{
STRUPR (OutputType);
if (OutputType[0] == 'W')
{
Display = DB_WORD_DISPLAY;
}
else if (OutputType[0] == 'D')
{
Display = DB_DWORD_DISPLAY;
}
else if (OutputType[0] == 'Q')
{
Display = DB_QWORD_DISPLAY;
}
}
RetBuf.Length = sizeof (Buffer);
RetBuf.Pointer = Buffer;
/* Differentiate between a number and a name */
if ((Target[0] >= 0x30) && (Target[0] <= 0x39))
{
ObjPtr = (void *) STRTOUL (Target, NULL, 16);
if (!OsdReadable (ObjPtr, 16))
{
OsdPrintf ("Address %p is invalid in this address space\n", ObjPtr);
return;
}
if (VALID_DESCRIPTOR_TYPE ((ObjPtr), DESC_TYPE_NTE))
{
/* This is an NTE */
if (!OsdReadable (ObjPtr, sizeof (NAME_TABLE_ENTRY)))
{
OsdPrintf ("Cannot read entire NTE at address %p\n", ObjPtr);
return;
}
Entry = ObjPtr;
goto DumpNte;
}
else if (VALID_DESCRIPTOR_TYPE ((ObjPtr), DESC_TYPE_ACPI_OBJ))
{
/* This is an ACPI OBJECT */
if (!OsdReadable (ObjPtr, sizeof (ACPI_OBJECT_INTERNAL)))
{
OsdPrintf ("Cannot read entire ACPI object at address %p\n", ObjPtr);
return;
}
CmDumpBuffer (ObjPtr, sizeof (ACPI_OBJECT_INTERNAL), Display, ACPI_UINT32_MAX);
AmlDumpObjectDescriptor (ObjPtr, 1);
}
else if (VALID_DESCRIPTOR_TYPE ((ObjPtr), DESC_TYPE_PARSER))
{
/* This is an Parser Op object */
if (!OsdReadable (ObjPtr, sizeof (ACPI_GENERIC_OP)))
{
OsdPrintf ("Cannot read entire Parser object at address %p\n", ObjPtr);
return;
}
CmDumpBuffer (ObjPtr, sizeof (ACPI_GENERIC_OP), Display, ACPI_UINT32_MAX);
DbDumpParserDescriptor ((ACPI_GENERIC_OP *) ObjPtr);
}
else
{
Size = 16;
if (OsdReadable (ObjPtr, 64))
{
Size = 64;
}
/* Just dump some memory */
CmDumpBuffer (ObjPtr, Size, Display, ACPI_UINT32_MAX);
}
return;
}
/* The parameter is a name string that must be resolved to an NTE */
Entry = DbLocalNsLookup (Target);
if (!Entry)
{
return;
}
DumpNte:
/* Now dump the NTE */
Status = AcpiGetName (Entry, ACPI_FULL_PATHNAME, &RetBuf);
if (ACPI_FAILURE (Status))
{
OsdPrintf ("Could not convert name to pathname\n");
return;
}
OsdPrintf ("Object Pathname: %s\n", RetBuf.Pointer);
if (!OsdReadable (Entry, sizeof (NAME_TABLE_ENTRY)))
{
OsdPrintf ("Invalid NTE at address %p\n", Entry);
return;
}
CmDumpBuffer ((void *) Entry, sizeof (NAME_TABLE_ENTRY), Display, ACPI_UINT32_MAX);
AmlDumpNameTableEntry (Entry, 1);
if (Entry->Object)
{
OsdPrintf ("\nAttached Object (0x%X):\n", Entry->Object);
if (!OsdReadable (Entry->Object, sizeof (ACPI_OBJECT_INTERNAL)))
{
OsdPrintf ("Invalid internal ACPI Object at address %p\n", Entry->Object);
return;
}
CmDumpBuffer (Entry->Object, sizeof (ACPI_OBJECT_INTERNAL), Display, ACPI_UINT32_MAX);
AmlDumpObjectDescriptor (Entry->Object, 1);
}
}
/******************************************************************************
*
* FUNCTION: DbDecodeInternalObject
*
* PARAMETERS:
*
* RETURN: None
*
* DESCRIPTION: Short display of an internal object
*
*****************************************************************************/
void
DbDecodeInternalObject (
ACPI_OBJECT_INTERNAL *ObjDesc)
{
if (!ObjDesc)
{
return;
}
OsdPrintf (" %9.9s ", CmGetTypeName (ObjDesc->Common.Type));
switch (ObjDesc->Common.Type)
{
case ACPI_TYPE_Number:
OsdPrintf ("0x%.8X", ObjDesc->Number.Value, ObjDesc->Number.Value);
break;
case ACPI_TYPE_String:
OsdPrintf ("\"%.16s\"...", ObjDesc->String.Pointer);
break;
}
}
/******************************************************************************
*
* FUNCTION: DbDisplayInternalObject
*
* PARAMETERS:
*
* RETURN: None
*
* DESCRIPTION: Short display of an internal object
*
*****************************************************************************/
void
DbDisplayInternalObject (
ACPI_OBJECT_INTERNAL *ObjDesc)
{
UINT8 Type;
ACPI_WALK_STATE *WalkState;
WalkState = DsGetCurrentWalkState (Gbl_CurrentWalkList);
OsdPrintf ("%p ", ObjDesc);
if (!ObjDesc)
{
OsdPrintf ("<NullObj>\n");
return;
}
else if (VALID_DESCRIPTOR_TYPE (ObjDesc, DESC_TYPE_PARSER))
{
OsdPrintf ("<Parser> ");
}
else if (VALID_DESCRIPTOR_TYPE (ObjDesc, DESC_TYPE_NTE))
{
OsdPrintf ("<NTE> Name %4.4s Type %s", &((NAME_TABLE_ENTRY *)ObjDesc)->Name,
CmGetTypeName (((NAME_TABLE_ENTRY *)ObjDesc)->Type));
}
else if (VALID_DESCRIPTOR_TYPE (ObjDesc, DESC_TYPE_ACPI_OBJ))
{
OsdPrintf ("<Obj> ");
Type = ObjDesc->Common.Type;
if (Type > INTERNAL_TYPE_MAX)
{
OsdPrintf (" Type %x [Invalid Type]", Type);
return;
}
switch (ObjDesc->Common.Type)
{
case INTERNAL_TYPE_Reference:
switch (ObjDesc->Reference.OpCode)
{
case AML_ZeroOp:
OsdPrintf ("[Const] Number 0x%.8X", 0);
break;
case AML_OnesOp:
OsdPrintf ("[Const] Number 0x%.8X", 0xFFFFFFFFF);
break;
case AML_OneOp:
OsdPrintf ("[Const] Number 0x%.8X", 1);
break;
case AML_LocalOp:
OsdPrintf ("[Local%d]", ObjDesc->Reference.Offset);
if (WalkState)
{
ObjDesc = WalkState->LocalVariables[ObjDesc->Reference.Offset].Object;
DbDecodeInternalObject (ObjDesc);
}
break;
case AML_ArgOp:
OsdPrintf ("[Arg%d] ", ObjDesc->Reference.Offset);
if (WalkState)
{
ObjDesc = WalkState->Arguments[ObjDesc->Reference.Offset].Object;
DbDecodeInternalObject (ObjDesc);
}
break;
case AML_DebugOp:
OsdPrintf ("[Debug] ");
break;
case AML_IndexOp:
OsdPrintf ("[Index] ");
DbDecodeInternalObject (ObjDesc->Reference.Object);
break;
default:
break;
}
break;
default:
OsdPrintf (" ");
DbDecodeInternalObject (ObjDesc);
break;
}
}
else
{
OsdPrintf ("<Not a valid ACPI Object Descriptor> ");
}
OsdPrintf ("\n");
}
/******************************************************************************
*
* FUNCTION: DbDisplayMethodInfo
*
* PARAMETERS:
*
* RETURN: None
*
* DESCRIPTION: Display information about the current method
*
*****************************************************************************/
void
DbDisplayMethodInfo (
ACPI_GENERIC_OP *StartOp)
{
ACPI_WALK_STATE *WalkState;
ACPI_OBJECT_INTERNAL *ObjDesc;
NAME_TABLE_ENTRY *Entry;
ACPI_GENERIC_OP *RootOp;
ACPI_GENERIC_OP *Op;
ACPI_OP_INFO *OpInfo;
UINT32 NumOps = 0;
UINT32 NumOperands = 0;
UINT32 NumOperators = 0;
UINT32 NumRemainingOps = 0;
UINT32 NumRemainingOperands = 0;
UINT32 NumRemainingOperators = 0;
UINT32 NumArgs;
UINT32 Concurrency;
BOOLEAN CountRemaining = FALSE;
WalkState = DsGetCurrentWalkState (Gbl_CurrentWalkList);
if (!WalkState)
{
OsdPrintf ("There is no method currently executing\n");
return;
}
ObjDesc = WalkState->MethodDesc;
Entry = WalkState->Origin->NameTableEntry;
NumArgs = ObjDesc->Method.ParamCount;
Concurrency = ObjDesc->Method.Concurrency;
OsdPrintf ("Currently executing control method is [%4.4s]\n", &Entry->Name);
OsdPrintf ("%d arguments, max concurrency = %d\n", NumArgs, Concurrency);
RootOp = StartOp;
while (RootOp->Parent)
{
RootOp = RootOp->Parent;
}
Op = RootOp;
while (Op)
{
if (Op == StartOp)
{
CountRemaining = TRUE;
}
NumOps++;
if (CountRemaining)
NumRemainingOps++;
OpInfo = PsGetOpcodeInfo (Op->Opcode);
if (!OpInfo)
{
continue;
}
/* Decode the opcode */
switch ((OpInfo->Flags & OP_INFO_TYPE))
{
case OPTYPE_CONSTANT: /* argument type only */
case OPTYPE_LITERAL: /* argument type only */
case OPTYPE_DATA_TERM: /* argument type only */
case OPTYPE_LOCAL_VARIABLE: /* argument type only */
case OPTYPE_METHOD_ARGUMENT: /* argument type only */
if (CountRemaining)
NumRemainingOperands++;
NumOperands++;
break;
default:
if (CountRemaining)
NumRemainingOperators++;
NumOperators++;
break;
}
Op = PsGetDepthNext (StartOp, Op);
}
OsdPrintf ("Method contains: %d AML Opcodes - %d Operators, %d Operands\n",
NumOps, NumOperators, NumOperands);
OsdPrintf ("Remaining to execute: %d AML Opcodes - %d Operators, %d Operands\n",
NumRemainingOps, NumRemainingOperators, NumRemainingOperands);
}
/******************************************************************************
*
* FUNCTION: DbDisplayLocals
*
* PARAMETERS:
*
* RETURN: None
*
* DESCRIPTION: Display all locals for a control method
*
*****************************************************************************/
void
DbDisplayLocals (void)
{
UINT32 i;
ACPI_WALK_STATE *WalkState;
ACPI_OBJECT_INTERNAL *ObjDesc;
NAME_TABLE_ENTRY *Entry;
WalkState = DsGetCurrentWalkState (Gbl_CurrentWalkList);
if (!WalkState)
{
OsdPrintf ("There is no method currently executing\n");
return;
}
ObjDesc = WalkState->MethodDesc;
Entry = WalkState->Origin->NameTableEntry;
OsdPrintf ("Local Variables for method [%4.4s]:\n", &Entry->Name);
for (i = 0; i < MTH_NUM_LOCALS; i++)
{
ObjDesc = WalkState->LocalVariables[i].Object;
OsdPrintf ("Local%d: ", i);
DbDisplayInternalObject (ObjDesc);
}
}
/******************************************************************************
*
* FUNCTION: DbDisplayArguments
*
* PARAMETERS:
*
* RETURN: None
*
* DESCRIPTION: Display all arguments for a control method
*
*****************************************************************************/
void
DbDisplayArguments (void)
{
UINT32 i;
ACPI_WALK_STATE *WalkState;
ACPI_OBJECT_INTERNAL *ObjDesc;
UINT32 NumArgs;
UINT32 Concurrency;
NAME_TABLE_ENTRY *Entry;
WalkState = DsGetCurrentWalkState (Gbl_CurrentWalkList);
if (!WalkState)
{
OsdPrintf ("There is no method currently executing\n");
return;
}
ObjDesc = WalkState->MethodDesc;
Entry = WalkState->Origin->NameTableEntry;
NumArgs = ObjDesc->Method.ParamCount;
Concurrency = ObjDesc->Method.Concurrency;
OsdPrintf ("Method [%4.4s] has %d arguments, max concurrency = %d\n", &Entry->Name, NumArgs, Concurrency);
for (i = 0; i < NumArgs; i++)
{
ObjDesc = WalkState->Arguments[i].Object;
OsdPrintf ("Arg%d: ", i);
DbDisplayInternalObject (ObjDesc);
}
}
/******************************************************************************
*
* FUNCTION: DbDisplayResults
*
* PARAMETERS:
*
* RETURN: None
*
* DESCRIPTION: Display current contents of a method result stack
*
*****************************************************************************/
void
DbDisplayResults (void)
{
UINT32 i;
ACPI_WALK_STATE *WalkState;
ACPI_OBJECT_INTERNAL *ObjDesc;
UINT32 NumResults;
NAME_TABLE_ENTRY *Entry;
WalkState = DsGetCurrentWalkState (Gbl_CurrentWalkList);
if (!WalkState)
{
OsdPrintf ("There is no method currently executing\n");
return;
}
ObjDesc = WalkState->MethodDesc;
Entry = WalkState->Origin->NameTableEntry;
NumResults = WalkState->NumResults - WalkState->CurrentResult;
OsdPrintf ("Method [%4.4s] has %d stacked result objects\n", &Entry->Name, NumResults);
for (i = WalkState->CurrentResult; i < WalkState->NumResults; i++)
{
ObjDesc = WalkState->Results[i];
OsdPrintf ("Result%d: ", i);
DbDisplayInternalObject (ObjDesc);
}
}
/******************************************************************************
*
* FUNCTION: DbDisplayCallingTree
*
* PARAMETERS:
*
* RETURN: None
*
* DESCRIPTION: Display current calling tree of nested control methods
*
*****************************************************************************/
void
DbDisplayCallingTree (void)
{
UINT32 i;
ACPI_WALK_STATE *WalkState;
ACPI_OBJECT_INTERNAL *ObjDesc;
NAME_TABLE_ENTRY *Entry;
WalkState = DsGetCurrentWalkState (Gbl_CurrentWalkList);
if (!WalkState)
{
OsdPrintf ("There is no method currently executing\n");
return;
}
ObjDesc = WalkState->MethodDesc;
Entry = WalkState->Origin->NameTableEntry;
OsdPrintf ("Current Control Method Call Tree\n");
for (i = 0; WalkState; i++)
{
ObjDesc = WalkState->MethodDesc;
Entry = WalkState->Origin->NameTableEntry;
OsdPrintf (" [%4.4s]\n", &Entry->Name);
WalkState = WalkState->Next;
}
}
/******************************************************************************
*
* FUNCTION: DbDisplayResultObject
*
* PARAMETERS:
*
* RETURN: None
*
* DESCRIPTION: Display the result of an AML opcode
*
*****************************************************************************/
void
DbDisplayResultObject (
ACPI_OBJECT_INTERNAL *ObjDesc)
{
/* TBD:
* We don't always want to display the result.
* For now, only display if single stepping
* however, this output is very useful in other contexts also
*/
if (!Gbl_CmSingleStep)
{
return;
}
OsdPrintf ("ResultObj: ");
DbDisplayInternalObject (ObjDesc);
OsdPrintf ("\n");
}
/******************************************************************************
*
* FUNCTION: DbDisplayArgumentObject
*
* PARAMETERS:
*
* RETURN: None
*
* DESCRIPTION: Display the result of an AML opcode
*
*****************************************************************************/
void
DbDisplayArgumentObject (
ACPI_OBJECT_INTERNAL *ObjDesc)
{
if (!Gbl_CmSingleStep)
{
return;
}
OsdPrintf ("ArgObj: ");
DbDisplayInternalObject (ObjDesc);
}
#endif /* ACPI_DEBUG */