1 /******************************************************************************* 2 * 3 * Module Name: dbobject - 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 - 2017, 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 * Alternatively, you may choose to be licensed under the terms of the 117 * following license: 118 * 119 * Redistribution and use in source and binary forms, with or without 120 * modification, are permitted provided that the following conditions 121 * are met: 122 * 1. Redistributions of source code must retain the above copyright 123 * notice, this list of conditions, and the following disclaimer, 124 * without modification. 125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 126 * substantially similar to the "NO WARRANTY" disclaimer below 127 * ("Disclaimer") and any redistribution must be conditioned upon 128 * including a substantially similar Disclaimer requirement for further 129 * binary redistribution. 130 * 3. Neither the names of the above-listed copyright holders nor the names 131 * of any contributors may be used to endorse or promote products derived 132 * from this software without specific prior written permission. 133 * 134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 145 * 146 * Alternatively, you may choose to be licensed under the terms of the 147 * GNU General Public License ("GPL") version 2 as published by the Free 148 * Software Foundation. 149 * 150 *****************************************************************************/ 151 152 #include "acpi.h" 153 #include "accommon.h" 154 #include "acnamesp.h" 155 #include "acdebug.h" 156 157 158 #ifdef ACPI_DEBUGGER 159 160 #define _COMPONENT ACPI_CA_DEBUGGER 161 ACPI_MODULE_NAME ("dbobject") 162 163 164 /* Local prototypes */ 165 166 static void 167 AcpiDbDecodeNode ( 168 ACPI_NAMESPACE_NODE *Node); 169 170 171 /******************************************************************************* 172 * 173 * FUNCTION: AcpiDbDumpMethodInfo 174 * 175 * PARAMETERS: Status - Method execution status 176 * WalkState - Current state of the parse tree walk 177 * 178 * RETURN: None 179 * 180 * DESCRIPTION: Called when a method has been aborted because of an error. 181 * Dumps the method execution stack, and the method locals/args, 182 * and disassembles the AML opcode that failed. 183 * 184 ******************************************************************************/ 185 186 void 187 AcpiDbDumpMethodInfo ( 188 ACPI_STATUS Status, 189 ACPI_WALK_STATE *WalkState) 190 { 191 ACPI_THREAD_STATE *Thread; 192 193 194 /* Ignore control codes, they are not errors */ 195 196 if ((Status & AE_CODE_MASK) == AE_CODE_CONTROL) 197 { 198 return; 199 } 200 201 /* We may be executing a deferred opcode */ 202 203 if (WalkState->DeferredNode) 204 { 205 AcpiOsPrintf ("Executing subtree for Buffer/Package/Region\n"); 206 return; 207 } 208 209 /* 210 * If there is no Thread, we are not actually executing a method. 211 * This can happen when the iASL compiler calls the interpreter 212 * to perform constant folding. 213 */ 214 Thread = WalkState->Thread; 215 if (!Thread) 216 { 217 return; 218 } 219 220 /* Display the method locals and arguments */ 221 222 AcpiOsPrintf ("\n"); 223 AcpiDbDecodeLocals (WalkState); 224 AcpiOsPrintf ("\n"); 225 AcpiDbDecodeArguments (WalkState); 226 AcpiOsPrintf ("\n"); 227 } 228 229 230 /******************************************************************************* 231 * 232 * FUNCTION: AcpiDbDecodeInternalObject 233 * 234 * PARAMETERS: ObjDesc - Object to be displayed 235 * 236 * RETURN: None 237 * 238 * DESCRIPTION: Short display of an internal object. Numbers/Strings/Buffers. 239 * 240 ******************************************************************************/ 241 242 void 243 AcpiDbDecodeInternalObject ( 244 ACPI_OPERAND_OBJECT *ObjDesc) 245 { 246 UINT32 i; 247 248 249 if (!ObjDesc) 250 { 251 AcpiOsPrintf (" Uninitialized"); 252 return; 253 } 254 255 if (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc) != ACPI_DESC_TYPE_OPERAND) 256 { 257 AcpiOsPrintf (" %p [%s]", ObjDesc, 258 AcpiUtGetDescriptorName (ObjDesc)); 259 return; 260 } 261 262 AcpiOsPrintf (" %s", AcpiUtGetObjectTypeName (ObjDesc)); 263 264 switch (ObjDesc->Common.Type) 265 { 266 case ACPI_TYPE_INTEGER: 267 268 AcpiOsPrintf (" %8.8X%8.8X", 269 ACPI_FORMAT_UINT64 (ObjDesc->Integer.Value)); 270 break; 271 272 case ACPI_TYPE_STRING: 273 274 AcpiOsPrintf ("(%u) \"%.60s", 275 ObjDesc->String.Length, ObjDesc->String.Pointer); 276 277 if (ObjDesc->String.Length > 60) 278 { 279 AcpiOsPrintf ("..."); 280 } 281 else 282 { 283 AcpiOsPrintf ("\""); 284 } 285 break; 286 287 case ACPI_TYPE_BUFFER: 288 289 AcpiOsPrintf ("(%u)", ObjDesc->Buffer.Length); 290 for (i = 0; (i < 8) && (i < ObjDesc->Buffer.Length); i++) 291 { 292 AcpiOsPrintf (" %2.2X", ObjDesc->Buffer.Pointer[i]); 293 } 294 break; 295 296 default: 297 298 AcpiOsPrintf (" %p", ObjDesc); 299 break; 300 } 301 } 302 303 304 /******************************************************************************* 305 * 306 * FUNCTION: AcpiDbDecodeNode 307 * 308 * PARAMETERS: Node - Object to be displayed 309 * 310 * RETURN: None 311 * 312 * DESCRIPTION: Short display of a namespace node 313 * 314 ******************************************************************************/ 315 316 static void 317 AcpiDbDecodeNode ( 318 ACPI_NAMESPACE_NODE *Node) 319 { 320 321 AcpiOsPrintf ("<Node> Name %4.4s", 322 AcpiUtGetNodeName (Node)); 323 324 if (Node->Flags & ANOBJ_METHOD_ARG) 325 { 326 AcpiOsPrintf (" [Method Arg]"); 327 } 328 if (Node->Flags & ANOBJ_METHOD_LOCAL) 329 { 330 AcpiOsPrintf (" [Method Local]"); 331 } 332 333 switch (Node->Type) 334 { 335 /* These types have no attached object */ 336 337 case ACPI_TYPE_DEVICE: 338 339 AcpiOsPrintf (" Device"); 340 break; 341 342 case ACPI_TYPE_THERMAL: 343 344 AcpiOsPrintf (" Thermal Zone"); 345 break; 346 347 default: 348 349 AcpiDbDecodeInternalObject (AcpiNsGetAttachedObject (Node)); 350 break; 351 } 352 } 353 354 355 /******************************************************************************* 356 * 357 * FUNCTION: AcpiDbDisplayInternalObject 358 * 359 * PARAMETERS: ObjDesc - Object to be displayed 360 * WalkState - Current walk state 361 * 362 * RETURN: None 363 * 364 * DESCRIPTION: Short display of an internal object 365 * 366 ******************************************************************************/ 367 368 void 369 AcpiDbDisplayInternalObject ( 370 ACPI_OPERAND_OBJECT *ObjDesc, 371 ACPI_WALK_STATE *WalkState) 372 { 373 UINT8 Type; 374 375 376 AcpiOsPrintf ("%p ", ObjDesc); 377 378 if (!ObjDesc) 379 { 380 AcpiOsPrintf ("<Null Object>\n"); 381 return; 382 } 383 384 /* Decode the object type */ 385 386 switch (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc)) 387 { 388 case ACPI_DESC_TYPE_PARSER: 389 390 AcpiOsPrintf ("<Parser> "); 391 break; 392 393 case ACPI_DESC_TYPE_NAMED: 394 395 AcpiDbDecodeNode ((ACPI_NAMESPACE_NODE *) ObjDesc); 396 break; 397 398 case ACPI_DESC_TYPE_OPERAND: 399 400 Type = ObjDesc->Common.Type; 401 if (Type > ACPI_TYPE_LOCAL_MAX) 402 { 403 AcpiOsPrintf (" Type %X [Invalid Type]", (UINT32) Type); 404 return; 405 } 406 407 /* Decode the ACPI object type */ 408 409 switch (ObjDesc->Common.Type) 410 { 411 case ACPI_TYPE_LOCAL_REFERENCE: 412 413 AcpiOsPrintf ("[%s] ", AcpiUtGetReferenceName (ObjDesc)); 414 415 /* Decode the refererence */ 416 417 switch (ObjDesc->Reference.Class) 418 { 419 case ACPI_REFCLASS_LOCAL: 420 421 AcpiOsPrintf ("%X ", ObjDesc->Reference.Value); 422 if (WalkState) 423 { 424 ObjDesc = WalkState->LocalVariables 425 [ObjDesc->Reference.Value].Object; 426 AcpiOsPrintf ("%p", ObjDesc); 427 AcpiDbDecodeInternalObject (ObjDesc); 428 } 429 break; 430 431 case ACPI_REFCLASS_ARG: 432 433 AcpiOsPrintf ("%X ", ObjDesc->Reference.Value); 434 if (WalkState) 435 { 436 ObjDesc = WalkState->Arguments 437 [ObjDesc->Reference.Value].Object; 438 AcpiOsPrintf ("%p", ObjDesc); 439 AcpiDbDecodeInternalObject (ObjDesc); 440 } 441 break; 442 443 case ACPI_REFCLASS_INDEX: 444 445 switch (ObjDesc->Reference.TargetType) 446 { 447 case ACPI_TYPE_BUFFER_FIELD: 448 449 AcpiOsPrintf ("%p", ObjDesc->Reference.Object); 450 AcpiDbDecodeInternalObject (ObjDesc->Reference.Object); 451 break; 452 453 case ACPI_TYPE_PACKAGE: 454 455 AcpiOsPrintf ("%p", ObjDesc->Reference.Where); 456 if (!ObjDesc->Reference.Where) 457 { 458 AcpiOsPrintf (" Uninitialized WHERE pointer"); 459 } 460 else 461 { 462 AcpiDbDecodeInternalObject ( 463 *(ObjDesc->Reference.Where)); 464 } 465 break; 466 467 default: 468 469 AcpiOsPrintf ("Unknown index target type"); 470 break; 471 } 472 break; 473 474 case ACPI_REFCLASS_REFOF: 475 476 if (!ObjDesc->Reference.Object) 477 { 478 AcpiOsPrintf ( 479 "Uninitialized reference subobject pointer"); 480 break; 481 } 482 483 /* Reference can be to a Node or an Operand object */ 484 485 switch (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc->Reference.Object)) 486 { 487 case ACPI_DESC_TYPE_NAMED: 488 489 AcpiDbDecodeNode (ObjDesc->Reference.Object); 490 break; 491 492 case ACPI_DESC_TYPE_OPERAND: 493 494 AcpiDbDecodeInternalObject (ObjDesc->Reference.Object); 495 break; 496 497 default: 498 break; 499 } 500 break; 501 502 case ACPI_REFCLASS_NAME: 503 504 AcpiDbDecodeNode (ObjDesc->Reference.Node); 505 break; 506 507 case ACPI_REFCLASS_DEBUG: 508 case ACPI_REFCLASS_TABLE: 509 510 AcpiOsPrintf ("\n"); 511 break; 512 513 default: /* Unknown reference class */ 514 515 AcpiOsPrintf ("%2.2X\n", ObjDesc->Reference.Class); 516 break; 517 } 518 break; 519 520 default: 521 522 AcpiOsPrintf ("<Obj> "); 523 AcpiDbDecodeInternalObject (ObjDesc); 524 break; 525 } 526 break; 527 528 default: 529 530 AcpiOsPrintf ("<Not a valid ACPI Object Descriptor> [%s]", 531 AcpiUtGetDescriptorName (ObjDesc)); 532 break; 533 } 534 535 AcpiOsPrintf ("\n"); 536 } 537 538 539 /******************************************************************************* 540 * 541 * FUNCTION: AcpiDbDecodeLocals 542 * 543 * PARAMETERS: WalkState - State for current method 544 * 545 * RETURN: None 546 * 547 * DESCRIPTION: Display all locals for the currently running control method 548 * 549 ******************************************************************************/ 550 551 void 552 AcpiDbDecodeLocals ( 553 ACPI_WALK_STATE *WalkState) 554 { 555 UINT32 i; 556 ACPI_OPERAND_OBJECT *ObjDesc; 557 ACPI_NAMESPACE_NODE *Node; 558 BOOLEAN DisplayLocals = FALSE; 559 560 561 ObjDesc = WalkState->MethodDesc; 562 Node = WalkState->MethodNode; 563 564 if (!Node) 565 { 566 AcpiOsPrintf ( 567 "No method node (Executing subtree for buffer or opregion)\n"); 568 return; 569 } 570 571 if (Node->Type != ACPI_TYPE_METHOD) 572 { 573 AcpiOsPrintf ("Executing subtree for Buffer/Package/Region\n"); 574 return; 575 } 576 577 /* Are any locals actually set? */ 578 579 for (i = 0; i < ACPI_METHOD_NUM_LOCALS; i++) 580 { 581 ObjDesc = WalkState->LocalVariables[i].Object; 582 if (ObjDesc) 583 { 584 DisplayLocals = TRUE; 585 break; 586 } 587 } 588 589 /* If any are set, only display the ones that are set */ 590 591 if (DisplayLocals) 592 { 593 AcpiOsPrintf ("\nInitialized Local Variables for Method [%4.4s]:\n", 594 AcpiUtGetNodeName (Node)); 595 596 for (i = 0; i < ACPI_METHOD_NUM_LOCALS; i++) 597 { 598 ObjDesc = WalkState->LocalVariables[i].Object; 599 if (ObjDesc) 600 { 601 AcpiOsPrintf (" Local%X: ", i); 602 AcpiDbDisplayInternalObject (ObjDesc, WalkState); 603 } 604 } 605 } 606 else 607 { 608 AcpiOsPrintf ( 609 "No Local Variables are initialized for Method [%4.4s]\n", 610 AcpiUtGetNodeName (Node)); 611 } 612 } 613 614 615 /******************************************************************************* 616 * 617 * FUNCTION: AcpiDbDecodeArguments 618 * 619 * PARAMETERS: WalkState - State for current method 620 * 621 * RETURN: None 622 * 623 * DESCRIPTION: Display all arguments for the currently running control method 624 * 625 ******************************************************************************/ 626 627 void 628 AcpiDbDecodeArguments ( 629 ACPI_WALK_STATE *WalkState) 630 { 631 UINT32 i; 632 ACPI_OPERAND_OBJECT *ObjDesc; 633 ACPI_NAMESPACE_NODE *Node; 634 BOOLEAN DisplayArgs = FALSE; 635 636 637 Node = WalkState->MethodNode; 638 ObjDesc = WalkState->MethodDesc; 639 640 if (!Node) 641 { 642 AcpiOsPrintf ( 643 "No method node (Executing subtree for buffer or opregion)\n"); 644 return; 645 } 646 647 if (Node->Type != ACPI_TYPE_METHOD) 648 { 649 AcpiOsPrintf ("Executing subtree for Buffer/Package/Region\n"); 650 return; 651 } 652 653 /* Are any arguments actually set? */ 654 655 for (i = 0; i < ACPI_METHOD_NUM_ARGS; i++) 656 { 657 ObjDesc = WalkState->Arguments[i].Object; 658 if (ObjDesc) 659 { 660 DisplayArgs = TRUE; 661 break; 662 } 663 } 664 665 /* If any are set, only display the ones that are set */ 666 667 if (DisplayArgs) 668 { 669 AcpiOsPrintf ( 670 "Initialized Arguments for Method [%4.4s]: " 671 "(%X arguments defined for method invocation)\n", 672 AcpiUtGetNodeName (Node), Node->Object->Method.ParamCount); 673 674 for (i = 0; i < ACPI_METHOD_NUM_ARGS; i++) 675 { 676 ObjDesc = WalkState->Arguments[i].Object; 677 if (ObjDesc) 678 { 679 AcpiOsPrintf (" Arg%u: ", i); 680 AcpiDbDisplayInternalObject (ObjDesc, WalkState); 681 } 682 } 683 } 684 else 685 { 686 AcpiOsPrintf ( 687 "No Arguments are initialized for method [%4.4s]\n", 688 AcpiUtGetNodeName (Node)); 689 } 690 } 691 692 #endif 693