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