drivers/acpi/components/disassembler/dmobject.c

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