1 /******************************************************************************* 2 * 3 * Module Name: dbxface - AML Debugger external interfaces 4 * $Revision: 1.79 $ 5 * 6 ******************************************************************************/ 7 8 /****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999 - 2008, 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 "acdebug.h" 121 #include "acdisasm.h" 122 123 124 #ifdef ACPI_DEBUGGER 125 126 #define _COMPONENT ACPI_CA_DEBUGGER 127 ACPI_MODULE_NAME ("dbxface") 128 129 130 /* Local prototypes */ 131 132 static ACPI_STATUS 133 AcpiDbStartCommand ( 134 ACPI_WALK_STATE *WalkState, 135 ACPI_PARSE_OBJECT *Op); 136 137 #ifdef ACPI_OBSOLETE_FUNCTIONS 138 void 139 AcpiDbMethodEnd ( 140 ACPI_WALK_STATE *WalkState); 141 #endif 142 143 144 /******************************************************************************* 145 * 146 * FUNCTION: AcpiDbStartCommand 147 * 148 * PARAMETERS: WalkState - Current walk 149 * Op - Current executing Op, from AML interpreter 150 * 151 * RETURN: Status 152 * 153 * DESCRIPTION: Enter debugger command loop 154 * 155 ******************************************************************************/ 156 157 static ACPI_STATUS 158 AcpiDbStartCommand ( 159 ACPI_WALK_STATE *WalkState, 160 ACPI_PARSE_OBJECT *Op) 161 { 162 ACPI_STATUS Status; 163 164 165 /* TBD: [Investigate] are there namespace locking issues here? */ 166 167 /* AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); */ 168 169 /* Go into the command loop and await next user command */ 170 171 172 AcpiGbl_MethodExecuting = TRUE; 173 Status = AE_CTRL_TRUE; 174 while (Status == AE_CTRL_TRUE) 175 { 176 if (AcpiGbl_DebuggerConfiguration == DEBUGGER_MULTI_THREADED) 177 { 178 /* Handshake with the front-end that gets user command lines */ 179 180 Status = AcpiUtReleaseMutex (ACPI_MTX_DEBUG_CMD_COMPLETE); 181 if (ACPI_FAILURE (Status)) 182 { 183 return (Status); 184 } 185 Status = AcpiUtAcquireMutex (ACPI_MTX_DEBUG_CMD_READY); 186 if (ACPI_FAILURE (Status)) 187 { 188 return (Status); 189 } 190 } 191 else 192 { 193 /* Single threaded, we must get a command line ourselves */ 194 195 /* Force output to console until a command is entered */ 196 197 AcpiDbSetOutputDestination (ACPI_DB_CONSOLE_OUTPUT); 198 199 /* Different prompt if method is executing */ 200 201 if (!AcpiGbl_MethodExecuting) 202 { 203 AcpiOsPrintf ("%1c ", ACPI_DEBUGGER_COMMAND_PROMPT); 204 } 205 else 206 { 207 AcpiOsPrintf ("%1c ", ACPI_DEBUGGER_EXECUTE_PROMPT); 208 } 209 210 /* Get the user input line */ 211 212 (void) AcpiOsGetLine (AcpiGbl_DbLineBuf); 213 } 214 215 Status = AcpiDbCommandDispatch (AcpiGbl_DbLineBuf, WalkState, Op); 216 } 217 218 /* AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE); */ 219 220 return (Status); 221 } 222 223 224 /******************************************************************************* 225 * 226 * FUNCTION: AcpiDbSingleStep 227 * 228 * PARAMETERS: WalkState - Current walk 229 * Op - Current executing op (from aml interpreter) 230 * OpcodeClass - Class of the current AML Opcode 231 * 232 * RETURN: Status 233 * 234 * DESCRIPTION: Called just before execution of an AML opcode. 235 * 236 ******************************************************************************/ 237 238 ACPI_STATUS 239 AcpiDbSingleStep ( 240 ACPI_WALK_STATE *WalkState, 241 ACPI_PARSE_OBJECT *Op, 242 UINT32 OpcodeClass) 243 { 244 ACPI_PARSE_OBJECT *Next; 245 ACPI_STATUS Status = AE_OK; 246 UINT32 OriginalDebugLevel; 247 ACPI_PARSE_OBJECT *DisplayOp; 248 ACPI_PARSE_OBJECT *ParentOp; 249 250 251 ACPI_FUNCTION_ENTRY (); 252 253 254 /* Check the abort flag */ 255 256 if (AcpiGbl_AbortMethod) 257 { 258 AcpiGbl_AbortMethod = FALSE; 259 return (AE_ABORT_METHOD); 260 } 261 262 /* Check for single-step breakpoint */ 263 264 if (WalkState->MethodBreakpoint && 265 (WalkState->MethodBreakpoint <= Op->Common.AmlOffset)) 266 { 267 /* Check if the breakpoint has been reached or passed */ 268 /* Hit the breakpoint, resume single step, reset breakpoint */ 269 270 AcpiOsPrintf ("***Break*** at AML offset %X\n", Op->Common.AmlOffset); 271 AcpiGbl_CmSingleStep = TRUE; 272 AcpiGbl_StepToNextCall = FALSE; 273 WalkState->MethodBreakpoint = 0; 274 } 275 276 /* Check for user breakpoint (Must be on exact Aml offset) */ 277 278 else if (WalkState->UserBreakpoint && 279 (WalkState->UserBreakpoint == Op->Common.AmlOffset)) 280 { 281 AcpiOsPrintf ("***UserBreakpoint*** at AML offset %X\n", 282 Op->Common.AmlOffset); 283 AcpiGbl_CmSingleStep = TRUE; 284 AcpiGbl_StepToNextCall = FALSE; 285 WalkState->MethodBreakpoint = 0; 286 } 287 288 /* 289 * Check if this is an opcode that we are interested in -- 290 * namely, opcodes that have arguments 291 */ 292 if (Op->Common.AmlOpcode == AML_INT_NAMEDFIELD_OP) 293 { 294 return (AE_OK); 295 } 296 297 switch (OpcodeClass) 298 { 299 case AML_CLASS_UNKNOWN: 300 case AML_CLASS_ARGUMENT: /* constants, literals, etc. do nothing */ 301 return (AE_OK); 302 303 default: 304 /* All other opcodes -- continue */ 305 break; 306 } 307 308 /* 309 * Under certain debug conditions, display this opcode and its operands 310 */ 311 if ((AcpiGbl_DbOutputToFile) || 312 (AcpiGbl_CmSingleStep) || 313 (AcpiDbgLevel & ACPI_LV_PARSE)) 314 { 315 if ((AcpiGbl_DbOutputToFile) || 316 (AcpiDbgLevel & ACPI_LV_PARSE)) 317 { 318 AcpiOsPrintf ("\n[AmlDebug] Next AML Opcode to execute:\n"); 319 } 320 321 /* 322 * Display this op (and only this op - zero out the NEXT field 323 * temporarily, and disable parser trace output for the duration of 324 * the display because we don't want the extraneous debug output) 325 */ 326 OriginalDebugLevel = AcpiDbgLevel; 327 AcpiDbgLevel &= ~(ACPI_LV_PARSE | ACPI_LV_FUNCTIONS); 328 Next = Op->Common.Next; 329 Op->Common.Next = NULL; 330 331 332 DisplayOp = Op; 333 ParentOp = Op->Common.Parent; 334 if (ParentOp) 335 { 336 if ((WalkState->ControlState) && 337 (WalkState->ControlState->Common.State == 338 ACPI_CONTROL_PREDICATE_EXECUTING)) 339 { 340 /* 341 * We are executing the predicate of an IF or WHILE statement 342 * Search upwards for the containing IF or WHILE so that the 343 * entire predicate can be displayed. 344 */ 345 while (ParentOp) 346 { 347 if ((ParentOp->Common.AmlOpcode == AML_IF_OP) || 348 (ParentOp->Common.AmlOpcode == AML_WHILE_OP)) 349 { 350 DisplayOp = ParentOp; 351 break; 352 } 353 ParentOp = ParentOp->Common.Parent; 354 } 355 } 356 else 357 { 358 while (ParentOp) 359 { 360 if ((ParentOp->Common.AmlOpcode == AML_IF_OP) || 361 (ParentOp->Common.AmlOpcode == AML_ELSE_OP) || 362 (ParentOp->Common.AmlOpcode == AML_SCOPE_OP) || 363 (ParentOp->Common.AmlOpcode == AML_METHOD_OP) || 364 (ParentOp->Common.AmlOpcode == AML_WHILE_OP)) 365 { 366 break; 367 } 368 DisplayOp = ParentOp; 369 ParentOp = ParentOp->Common.Parent; 370 } 371 } 372 } 373 374 /* Now we can display it */ 375 376 AcpiDmDisassemble (WalkState, DisplayOp, ACPI_UINT32_MAX); 377 378 if ((Op->Common.AmlOpcode == AML_IF_OP) || 379 (Op->Common.AmlOpcode == AML_WHILE_OP)) 380 { 381 if (WalkState->ControlState->Common.Value) 382 { 383 AcpiOsPrintf ("Predicate = [True], IF block was executed\n"); 384 } 385 else 386 { 387 AcpiOsPrintf ("Predicate = [False], Skipping IF block\n"); 388 } 389 } 390 else if (Op->Common.AmlOpcode == AML_ELSE_OP) 391 { 392 AcpiOsPrintf ("Predicate = [False], ELSE block was executed\n"); 393 } 394 395 /* Restore everything */ 396 397 Op->Common.Next = Next; 398 AcpiOsPrintf ("\n"); 399 if ((AcpiGbl_DbOutputToFile) || 400 (AcpiDbgLevel & ACPI_LV_PARSE)) 401 { 402 AcpiOsPrintf ("\n"); 403 } 404 AcpiDbgLevel = OriginalDebugLevel; 405 } 406 407 /* If we are not single stepping, just continue executing the method */ 408 409 if (!AcpiGbl_CmSingleStep) 410 { 411 return (AE_OK); 412 } 413 414 /* 415 * If we are executing a step-to-call command, 416 * Check if this is a method call. 417 */ 418 if (AcpiGbl_StepToNextCall) 419 { 420 if (Op->Common.AmlOpcode != AML_INT_METHODCALL_OP) 421 { 422 /* Not a method call, just keep executing */ 423 424 return (AE_OK); 425 } 426 427 /* Found a method call, stop executing */ 428 429 AcpiGbl_StepToNextCall = FALSE; 430 } 431 432 /* 433 * If the next opcode is a method call, we will "step over" it 434 * by default. 435 */ 436 if (Op->Common.AmlOpcode == AML_INT_METHODCALL_OP) 437 { 438 /* Force no more single stepping while executing called method */ 439 440 AcpiGbl_CmSingleStep = FALSE; 441 442 /* 443 * Set the breakpoint on/before the call, it will stop execution 444 * as soon as we return 445 */ 446 WalkState->MethodBreakpoint = 1; /* Must be non-zero! */ 447 } 448 449 450 Status = AcpiDbStartCommand (WalkState, Op); 451 452 /* User commands complete, continue execution of the interrupted method */ 453 454 return (Status); 455 } 456 457 458 /******************************************************************************* 459 * 460 * FUNCTION: AcpiDbInitialize 461 * 462 * PARAMETERS: None 463 * 464 * RETURN: Status 465 * 466 * DESCRIPTION: Init and start debugger 467 * 468 ******************************************************************************/ 469 470 ACPI_STATUS 471 AcpiDbInitialize ( 472 void) 473 { 474 ACPI_STATUS Status; 475 476 477 /* Init globals */ 478 479 AcpiGbl_DbBuffer = NULL; 480 AcpiGbl_DbFilename = NULL; 481 AcpiGbl_DbOutputToFile = FALSE; 482 483 AcpiGbl_DbDebugLevel = ACPI_LV_VERBOSITY2; 484 AcpiGbl_DbConsoleDebugLevel = ACPI_NORMAL_DEFAULT | ACPI_LV_TABLES; 485 AcpiGbl_DbOutputFlags = ACPI_DB_CONSOLE_OUTPUT; 486 487 AcpiGbl_DbOpt_tables = FALSE; 488 AcpiGbl_DbOpt_disasm = FALSE; 489 AcpiGbl_DbOpt_stats = FALSE; 490 AcpiGbl_DbOpt_verbose = TRUE; 491 AcpiGbl_DbOpt_ini_methods = TRUE; 492 493 AcpiGbl_DbBuffer = AcpiOsAllocate (ACPI_DEBUG_BUFFER_SIZE); 494 if (!AcpiGbl_DbBuffer) 495 { 496 return (AE_NO_MEMORY); 497 } 498 ACPI_MEMSET (AcpiGbl_DbBuffer, 0, ACPI_DEBUG_BUFFER_SIZE); 499 500 /* Initial scope is the root */ 501 502 AcpiGbl_DbScopeBuf [0] = '\\'; 503 AcpiGbl_DbScopeBuf [1] = 0; 504 AcpiGbl_DbScopeNode = AcpiGbl_RootNode; 505 506 /* 507 * If configured for multi-thread support, the debug executor runs in 508 * a separate thread so that the front end can be in another address 509 * space, environment, or even another machine. 510 */ 511 if (AcpiGbl_DebuggerConfiguration & DEBUGGER_MULTI_THREADED) 512 { 513 /* These were created with one unit, grab it */ 514 515 Status = AcpiUtAcquireMutex (ACPI_MTX_DEBUG_CMD_COMPLETE); 516 if (ACPI_FAILURE (Status)) 517 { 518 AcpiOsPrintf ("Could not get debugger mutex\n"); 519 return (Status); 520 } 521 522 Status = AcpiUtAcquireMutex (ACPI_MTX_DEBUG_CMD_READY); 523 if (ACPI_FAILURE (Status)) 524 { 525 AcpiOsPrintf ("Could not get debugger mutex\n"); 526 return (Status); 527 } 528 529 /* Create the debug execution thread to execute commands */ 530 531 Status = AcpiOsExecute (OSL_DEBUGGER_THREAD, AcpiDbExecuteThread, NULL); 532 if (ACPI_FAILURE (Status)) 533 { 534 AcpiOsPrintf ("Could not start debugger thread\n"); 535 return (Status); 536 } 537 } 538 539 if (!AcpiGbl_DbOpt_verbose) 540 { 541 AcpiGbl_DbOpt_disasm = TRUE; 542 AcpiGbl_DbOpt_stats = FALSE; 543 } 544 545 return (AE_OK); 546 } 547 548 549 /******************************************************************************* 550 * 551 * FUNCTION: AcpiDbTerminate 552 * 553 * PARAMETERS: None 554 * 555 * RETURN: None 556 * 557 * DESCRIPTION: Stop debugger 558 * 559 ******************************************************************************/ 560 561 void 562 AcpiDbTerminate ( 563 void) 564 { 565 566 if (AcpiGbl_DbTablePtr) 567 { 568 AcpiOsFree (AcpiGbl_DbTablePtr); 569 } 570 if (AcpiGbl_DbBuffer) 571 { 572 AcpiOsFree (AcpiGbl_DbBuffer); 573 } 574 } 575 576 577 #ifdef ACPI_OBSOLETE_FUNCTIONS 578 /******************************************************************************* 579 * 580 * FUNCTION: AcpiDbMethodEnd 581 * 582 * PARAMETERS: WalkState - Current walk 583 * 584 * RETURN: Status 585 * 586 * DESCRIPTION: Called at method termination 587 * 588 ******************************************************************************/ 589 590 void 591 AcpiDbMethodEnd ( 592 ACPI_WALK_STATE *WalkState) 593 { 594 595 if (!AcpiGbl_CmSingleStep) 596 { 597 return; 598 } 599 600 AcpiOsPrintf ("<Method Terminating>\n"); 601 602 AcpiDbStartCommand (WalkState, NULL); 603 } 604 #endif 605 606 #endif /* ACPI_DEBUGGER */ 607