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