sys/contrib/dev/acpica-unix-20061109/disassembler/dmobject.c

   1 /*******************************************************************************
   2  *
   3  * Module Name: dmobject - ACPI object decode and display
   4  *              $Revision: 1.21 $
   5  *
   6  ******************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2006, Intel Corp.
  13  * All rights reserved.
  14  *
  15  * 2. License
  16  *
  17  * 2.1. This is your license from Intel Corp. under its intellectual property
  18  * rights.  You may have additional license terms from the party that provided
  19  * you this software, covering your right to use that party's intellectual
  20  * property rights.
  21  *
  22  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  23  * copy of the source code appearing in this file ("Covered Code") an
  24  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  25  * base code distributed originally by Intel ("Original Intel Code") to copy,
  26  * make derivatives, distribute, use and display any portion of the Covered
  27  * Code in any form, with the right to sublicense such rights; and
  28  *
  29  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  30  * license (with the right to sublicense), under only those claims of Intel
  31  * patents that are infringed by the Original Intel Code, to make, use, sell,
  32  * offer to sell, and import the Covered Code and derivative works thereof
  33  * solely to the minimum extent necessary to exercise the above copyright
  34  * license, and in no event shall the patent license extend to any additions
  35  * to or modifications of the Original Intel Code.  No other license or right
  36  * is granted directly or by implication, estoppel or otherwise;
  37  *
  38  * The above copyright and patent license is granted only if the following
  39  * conditions are met:
  40  *
  41  * 3. Conditions
  42  *
  43  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  44  * Redistribution of source code of any substantial portion of the Covered
  45  * Code or modification with rights to further distribute source must include
  46  * the above Copyright Notice, the above License, this list of Conditions,
  47  * and the following Disclaimer and Export Compliance provision.  In addition,
  48  * Licensee must cause all Covered Code to which Licensee contributes to
  49  * contain a file documenting the changes Licensee made to create that Covered
  50  * Code and the date of any change.  Licensee must include in that file the
  51  * documentation of any changes made by any predecessor Licensee.  Licensee
  52  * must include a prominent statement that the modification is derived,
  53  * directly or indirectly, from Original Intel Code.
  54  *
  55  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  56  * Redistribution of source code of any substantial portion of the Covered
  57  * Code or modification without rights to further distribute source must
  58  * include the following Disclaimer and Export Compliance provision in the
  59  * documentation and/or other materials provided with distribution.  In
  60  * addition, Licensee may not authorize further sublicense of source of any
  61  * portion of the Covered Code, and must include terms to the effect that the
  62  * license from Licensee to its licensee is limited to the intellectual
  63  * property embodied in the software Licensee provides to its licensee, and
  64  * not to intellectual property embodied in modifications its licensee may
  65  * make.
  66  *
  67  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  68  * substantial portion of the Covered Code or modification must reproduce the
  69  * above Copyright Notice, and the following Disclaimer and Export Compliance
  70  * provision in the documentation and/or other materials provided with the
  71  * distribution.
  72  *
  73  * 3.4. Intel retains all right, title, and interest in and to the Original
  74  * Intel Code.
  75  *
  76  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  77  * Intel shall be used in advertising or otherwise to promote the sale, use or
  78  * other dealings in products derived from or relating to the Covered Code
  79  * without prior written authorization from Intel.
  80  *
  81  * 4. Disclaimer and Export Compliance
  82  *
  83  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  84  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  85  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  86  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  87  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  88  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  89  * PARTICULAR PURPOSE.
  90  *
  91  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  92  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  93  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  94  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  95  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  96  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  97  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  98  * LIMITED REMEDY.
  99  *
 100  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 101  * software or system incorporating such software without first obtaining any
 102  * required license or other approval from the U. S. Department of Commerce or
 103  * any other agency or department of the United States Government.  In the
 104  * event Licensee exports any such software from the United States or
 105  * re-exports any such software from a foreign destination, Licensee shall
 106  * ensure that the distribution and export/re-export of the software is in
 107  * compliance with all laws, regulations, orders, or other restrictions of the
 108  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 109  * any of its subsidiaries will export/re-export any technical data, process,
 110  * software, or service, directly or indirectly, to any country for which the
 111  * United States government or any agency thereof requires an export license,
 112  * other governmental approval, or letter of assurance, without first obtaining
 113  * such license, approval or letter.
 114  *
 115  *****************************************************************************/
 116
 117
 118 #include "acpi.h"
 119 #include "amlcode.h"
 120 #include "acnamesp.h"
 121 #include "acdisasm.h"
 122 #include "acparser.h"
 123
 124
 125 #ifdef ACPI_DISASSEMBLER
 126
 127 #define _COMPONENT          ACPI_CA_DEBUGGER
 128         ACPI_MODULE_NAME    ("dmnames")
 129
 130 /* Local prototypes */
 131
 132 static void
 133 AcpiDmDecodeNode (
 134     ACPI_NAMESPACE_NODE     *Node);
 135
 136
 137 /*******************************************************************************
 138  *
 139  * FUNCTION:    AcpiDmDumpMethodInfo
 140  *
 141  * PARAMETERS:  Status          - Method execution status
 142  *              WalkState       - Current state of the parse tree walk
 143  *              Op              - Executing parse op
 144  *
 145  * RETURN:      None
 146  *
 147  * DESCRIPTION: Called when a method has been aborted because of an error.
 148  *              Dumps the method execution stack, and the method locals/args,
 149  *              and disassembles the AML opcode that failed.
 150  *
 151  ******************************************************************************/
 152
 153 void
 154 AcpiDmDumpMethodInfo (
 155     ACPI_STATUS             Status,
 156     ACPI_WALK_STATE         *WalkState,
 157     ACPI_PARSE_OBJECT       *Op)
 158 {
 159     ACPI_PARSE_OBJECT       *Next;
 160     ACPI_THREAD_STATE       *Thread;
 161     ACPI_WALK_STATE         *NextWalkState;
 162     ACPI_NAMESPACE_NODE     *PreviousMethod = NULL;
 163
 164
 165     /* Ignore control codes, they are not errors */
 166
 167     if ((Status & AE_CODE_MASK) == AE_CODE_CONTROL)
 168     {
 169         return;
 170     }
 171
 172     /* We may be executing a deferred opcode */
 173
 174     if (WalkState->DeferredNode)
 175     {
 176         AcpiOsPrintf ("Executing subtree for Buffer/Package/Region\n");
 177         return;
 178     }
 179
 180     /*
 181      * If there is no Thread, we are not actually executing a method.
 182      * This can happen when the iASL compiler calls the interpreter
 183      * to perform constant folding.
 184      */
 185     Thread = WalkState->Thread;
 186     if (!Thread)
 187     {
 188         return;
 189     }
 190
 191     /* Display exception and method name */
 192
 193     AcpiOsPrintf ("\n**** Exception %s during execution of method ",
 194         AcpiFormatException (Status));
 195     AcpiNsPrintNodePathname (WalkState->MethodNode, NULL);
 196
 197     /* Display stack of executing methods */
 198
 199     AcpiOsPrintf ("\n\nMethod Execution Stack:\n");
 200     NextWalkState = Thread->WalkStateList;
 201
 202     /* Walk list of linked walk states */
 203
 204     while (NextWalkState)
 205     {
 206         AcpiOsPrintf ("    Method [%4.4s] executing: ",
 207                 AcpiUtGetNodeName (NextWalkState->MethodNode));
 208
 209         /* First method is the currently executing method */
 210
 211         if (NextWalkState == WalkState)
 212         {
 213             if (Op)
 214             {
 215                 /* Display currently executing ASL statement */
 216
 217                 Next = Op->Common.Next;
 218                 Op->Common.Next = NULL;
 219
 220                 AcpiDmDisassemble (NextWalkState, Op, ACPI_UINT32_MAX);
 221                 Op->Common.Next = Next;
 222             }
 223         }
 224         else
 225         {
 226             /*
 227              * This method has called another method
 228              * NOTE: the method call parse subtree is already deleted at this
 229              * point, so we cannot disassemble the method invocation.
 230              */
 231             AcpiOsPrintf ("Call to method ");
 232             AcpiNsPrintNodePathname (PreviousMethod, NULL);
 233         }
 234
 235         PreviousMethod = NextWalkState->MethodNode;
 236         NextWalkState = NextWalkState->Next;
 237         AcpiOsPrintf ("\n");
 238     }
 239
 240     /* Display the method locals and arguments */
 241
 242     AcpiOsPrintf ("\n");
 243     AcpiDmDisplayLocals (WalkState);
 244     AcpiOsPrintf ("\n");
 245     AcpiDmDisplayArguments (WalkState);
 246     AcpiOsPrintf ("\n");
 247 }
 248
 249
 250 /*******************************************************************************
 251  *
 252  * FUNCTION:    AcpiDmDecodeInternalObject
 253  *
 254  * PARAMETERS:  ObjDesc         - Object to be displayed
 255  *
 256  * RETURN:      None
 257  *
 258  * DESCRIPTION: Short display of an internal object.  Numbers/Strings/Buffers.
 259  *
 260  ******************************************************************************/
 261
 262 void
 263 AcpiDmDecodeInternalObject (
 264     ACPI_OPERAND_OBJECT     *ObjDesc)
 265 {
 266     UINT32                  i;
 267
 268
 269     if (!ObjDesc)
 270     {
 271         AcpiOsPrintf (" Uninitialized");
 272         return;
 273     }
 274
 275     if (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc) != ACPI_DESC_TYPE_OPERAND)
 276     {
 277         AcpiOsPrintf (" %p [%s]", ObjDesc, AcpiUtGetDescriptorName (ObjDesc));
 278         return;
 279     }
 280
 281     AcpiOsPrintf (" %s", AcpiUtGetObjectTypeName (ObjDesc));
 282
 283     switch (ACPI_GET_OBJECT_TYPE (ObjDesc))
 284     {
 285     case ACPI_TYPE_INTEGER:
 286
 287         AcpiOsPrintf (" %8.8X%8.8X",
 288                 ACPI_FORMAT_UINT64 (ObjDesc->Integer.Value));
 289         break;
 290
 291
 292     case ACPI_TYPE_STRING:
 293
 294         AcpiOsPrintf ("(%d) \"%.24s",
 295                 ObjDesc->String.Length, ObjDesc->String.Pointer);
 296
 297         if (ObjDesc->String.Length > 24)
 298         {
 299             AcpiOsPrintf ("...");
 300         }
 301         else
 302         {
 303             AcpiOsPrintf ("\"");
 304         }
 305         break;
 306
 307
 308     case ACPI_TYPE_BUFFER:
 309
 310         AcpiOsPrintf ("(%d)", ObjDesc->Buffer.Length);
 311         for (i = 0; (i < 8) && (i < ObjDesc->Buffer.Length); i++)
 312         {
 313             AcpiOsPrintf (" %2.2X", ObjDesc->Buffer.Pointer[i]);
 314         }
 315         break;
 316
 317
 318     default:
 319
 320         AcpiOsPrintf (" %p", ObjDesc);
 321         break;
 322     }
 323 }
 324
 325
 326 /*******************************************************************************
 327  *
 328  * FUNCTION:    AcpiDmDecodeNode
 329  *
 330  * PARAMETERS:  Node        - Object to be displayed
 331  *
 332  * RETURN:      None
 333  *
 334  * DESCRIPTION: Short display of a namespace node
 335  *
 336  ******************************************************************************/
 337
 338 static void
 339 AcpiDmDecodeNode (
 340     ACPI_NAMESPACE_NODE     *Node)
 341 {
 342
 343     AcpiOsPrintf ("<Node>            Name %4.4s",
 344             AcpiUtGetNodeName (Node));
 345
 346     if (Node->Flags & ANOBJ_METHOD_ARG)
 347     {
 348         AcpiOsPrintf (" [Method Arg]");
 349     }
 350     if (Node->Flags & ANOBJ_METHOD_LOCAL)
 351     {
 352         AcpiOsPrintf (" [Method Local]");
 353     }
 354
 355     AcpiDmDecodeInternalObject (AcpiNsGetAttachedObject (Node));
 356 }
 357
 358
 359 /*******************************************************************************
 360  *
 361  * FUNCTION:    AcpiDmDisplayInternalObject
 362  *
 363  * PARAMETERS:  ObjDesc         - Object to be displayed
 364  *              WalkState       - Current walk state
 365  *
 366  * RETURN:      None
 367  *
 368  * DESCRIPTION: Short display of an internal object
 369  *
 370  ******************************************************************************/
 371
 372 void
 373 AcpiDmDisplayInternalObject (
 374     ACPI_OPERAND_OBJECT     *ObjDesc,
 375     ACPI_WALK_STATE         *WalkState)
 376 {
 377     UINT8                   Type;
 378
 379
 380     AcpiOsPrintf ("%p ", ObjDesc);
 381
 382     if (!ObjDesc)
 383     {
 384         AcpiOsPrintf ("<Null Object>\n");
 385         return;
 386     }
 387
 388     /* Decode the object type */
 389
 390     switch (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc))
 391     {
 392     case ACPI_DESC_TYPE_PARSER:
 393
 394         AcpiOsPrintf ("<Parser>  ");
 395         break;
 396
 397
 398     case ACPI_DESC_TYPE_NAMED:
 399
 400         AcpiDmDecodeNode ((ACPI_NAMESPACE_NODE *) ObjDesc);
 401         break;
 402
 403
 404     case ACPI_DESC_TYPE_OPERAND:
 405
 406         Type = ACPI_GET_OBJECT_TYPE (ObjDesc);
 407         if (Type > ACPI_TYPE_LOCAL_MAX)
 408         {
 409             AcpiOsPrintf (" Type %X [Invalid Type]", (UINT32) Type);
 410             return;
 411         }
 412
 413         /* Decode the ACPI object type */
 414
 415         switch (ACPI_GET_OBJECT_TYPE (ObjDesc))
 416         {
 417         case ACPI_TYPE_LOCAL_REFERENCE:
 418
 419             switch (ObjDesc->Reference.Opcode)
 420             {
 421             case AML_LOCAL_OP:
 422
 423                 AcpiOsPrintf ("[Local%d] ", ObjDesc->Reference.Offset);
 424                 if (WalkState)
 425                 {
 426                     ObjDesc = WalkState->LocalVariables[
 427                                 ObjDesc->Reference.Offset].Object;
 428                     AcpiOsPrintf ("%p", ObjDesc);
 429                     AcpiDmDecodeInternalObject (ObjDesc);
 430                 }
 431                 break;
 432
 433
 434             case AML_ARG_OP:
 435
 436                 AcpiOsPrintf ("[Arg%d]   ", ObjDesc->Reference.Offset);
 437                 if (WalkState)
 438                 {
 439                     ObjDesc = WalkState->Arguments[
 440                                 ObjDesc->Reference.Offset].Object;
 441                     AcpiOsPrintf ("%p", ObjDesc);
 442                     AcpiDmDecodeInternalObject (ObjDesc);
 443                 }
 444                 break;
 445
 446
 447             case AML_DEBUG_OP:
 448
 449                 AcpiOsPrintf ("[Debug]  ");
 450                 break;
 451
 452
 453             case AML_INDEX_OP:
 454
 455                 AcpiOsPrintf ("[Index]  ");
 456                 switch (ObjDesc->Reference.TargetType)
 457                 {
 458                 case ACPI_TYPE_BUFFER_FIELD:
 459                     AcpiOsPrintf ("%p", ObjDesc->Reference.Object);
 460                     AcpiDmDecodeInternalObject (ObjDesc->Reference.Object);
 461                     break;
 462
 463                 case ACPI_TYPE_PACKAGE:
 464
 465                     AcpiOsPrintf ("%p", ObjDesc->Reference.Where);
 466                     if (!ObjDesc->Reference.Where)
 467                     {
 468                         AcpiOsPrintf (" Uninitialized WHERE ptr");
 469                     }
 470                     else
 471                     {
 472                         AcpiDmDecodeInternalObject (
 473                             *(ObjDesc->Reference.Where));
 474                     }
 475                     break;
 476
 477                 default:
 478                     AcpiOsPrintf ("Unknown index target type");
 479                     break;
 480                 }
 481                 break;
 482
 483
 484             case AML_LOAD_OP:
 485
 486                 AcpiOsPrintf ("[DdbHandle]  ");
 487                 break;
 488
 489
 490             case AML_REF_OF_OP:
 491
 492                 AcpiOsPrintf ("[RefOf]          ");
 493
 494                 if (!ObjDesc->Reference.Object)
 495                 {
 496                     AcpiOsPrintf ("Uninitialized reference subobject ptr");
 497                     break;
 498                 }
 499
 500                 /* Reference can be to a Node or an Operand object */
 501
 502                 switch (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc->Reference.Object))
 503                 {
 504                 case ACPI_DESC_TYPE_NAMED:
 505                     AcpiDmDecodeNode (ObjDesc->Reference.Object);
 506                     break;
 507
 508                 case ACPI_DESC_TYPE_OPERAND:
 509                     AcpiDmDecodeInternalObject (ObjDesc->Reference.Object);
 510                     break;
 511
 512                 default:
 513                     break;
 514                 }
 515                 break;
 516
 517             case AML_INT_NAMEPATH_OP:
 518
 519                 AcpiDmDecodeNode (ObjDesc->Reference.Node);
 520                 break;
 521
 522             default:
 523
 524                 AcpiOsPrintf ("Unknown Reference opcode %X (%s)\n",
 525                     ObjDesc->Reference.Opcode,
 526                     AcpiPsGetOpcodeName (ObjDesc->Reference.Opcode));
 527                 break;
 528             }
 529             break;
 530
 531         default:
 532
 533             AcpiOsPrintf ("<Obj>            ");
 534             AcpiDmDecodeInternalObject (ObjDesc);
 535             break;
 536         }
 537         break;
 538
 539
 540     default:
 541
 542         AcpiOsPrintf ("<Not a valid ACPI Object Descriptor> [%s]",
 543                 AcpiUtGetDescriptorName (ObjDesc));
 544         break;
 545     }
 546
 547     AcpiOsPrintf ("\n");
 548 }
 549
 550
 551 /*******************************************************************************
 552  *
 553  * FUNCTION:    AcpiDmDisplayLocals
 554  *
 555  * PARAMETERS:  WalkState       - State for current method
 556  *
 557  * RETURN:      None
 558  *
 559  * DESCRIPTION: Display all locals for the currently running control method
 560  *
 561  ******************************************************************************/
 562
 563 void
 564 AcpiDmDisplayLocals (
 565     ACPI_WALK_STATE         *WalkState)
 566 {
 567     UINT32                  i;
 568     ACPI_OPERAND_OBJECT     *ObjDesc;
 569     ACPI_NAMESPACE_NODE     *Node;
 570
 571
 572     ObjDesc = WalkState->MethodDesc;
 573     Node    = WalkState->MethodNode;
 574     if (!Node)
 575     {
 576         AcpiOsPrintf (
 577             "No method node (Executing subtree for buffer or opregion)\n");
 578         return;
 579     }
 580
 581     if (Node->Type != ACPI_TYPE_METHOD)
 582     {
 583         AcpiOsPrintf ("Executing subtree for Buffer/Package/Region\n");
 584         return;
 585     }
 586
 587     AcpiOsPrintf ("Local Variables for method [%4.4s]:\n",
 588             AcpiUtGetNodeName (Node));
 589
 590     for (i = 0; i < ACPI_METHOD_NUM_LOCALS; i++)
 591     {
 592         ObjDesc = WalkState->LocalVariables[i].Object;
 593         AcpiOsPrintf ("    Local%X: ", i);
 594         AcpiDmDisplayInternalObject (ObjDesc, WalkState);
 595     }
 596 }
 597
 598
 599 /*******************************************************************************
 600  *
 601  * FUNCTION:    AcpiDmDisplayArguments
 602  *
 603  * PARAMETERS:  WalkState       - State for current method
 604  *
 605  * RETURN:      None
 606  *
 607  * DESCRIPTION: Display all arguments for the currently running control method
 608  *
 609  ******************************************************************************/
 610
 611 void
 612 AcpiDmDisplayArguments (
 613     ACPI_WALK_STATE         *WalkState)
 614 {
 615     UINT32                  i;
 616     ACPI_OPERAND_OBJECT     *ObjDesc;
 617     ACPI_NAMESPACE_NODE     *Node;
 618
 619
 620     ObjDesc = WalkState->MethodDesc;
 621     Node    = WalkState->MethodNode;
 622     if (!Node)
 623     {
 624         AcpiOsPrintf (
 625             "No method node (Executing subtree for buffer or opregion)\n");
 626         return;
 627     }
 628
 629     if (Node->Type != ACPI_TYPE_METHOD)
 630     {
 631         AcpiOsPrintf ("Executing subtree for Buffer/Package/Region\n");
 632         return;
 633     }
 634
 635     AcpiOsPrintf (
 636         "Arguments for Method [%4.4s]:  (%X arguments defined, max concurrency = %X)\n",
 637         AcpiUtGetNodeName (Node), ObjDesc->Method.ParamCount, ObjDesc->Method.SyncLevel);
 638
 639     for (i = 0; i < ACPI_METHOD_NUM_ARGS; i++)
 640     {
 641         ObjDesc = WalkState->Arguments[i].Object;
 642         AcpiOsPrintf ("    Arg%d:   ", i);
 643         AcpiDmDisplayInternalObject (ObjDesc, WalkState);
 644     }
 645 }
 646
 647 #endif
 648
 649