1 /*******************************************************************************
3 * Module Name: dbxface - AML Debugger external interfaces
5 ******************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2009, Intel Corp.
12 * All rights reserved.
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
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
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;
37 * The above copyright and patent license is granted only if the following
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.
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
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
72 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
80 * 4. Disclaimer and Export Compliance
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
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
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.
114 *****************************************************************************/
118 #include "accommon.h"
121 #include "acdisasm.h"
126 #define _COMPONENT ACPI_CA_DEBUGGER
127 ACPI_MODULE_NAME ("dbxface")
130 /* Local prototypes */
134 ACPI_WALK_STATE
*WalkState
,
135 ACPI_PARSE_OBJECT
*Op
);
137 #ifdef ACPI_OBSOLETE_FUNCTIONS
140 ACPI_WALK_STATE
*WalkState
);
144 /*******************************************************************************
146 * FUNCTION: AcpiDbStartCommand
148 * PARAMETERS: WalkState - Current walk
149 * Op - Current executing Op, from AML interpreter
153 * DESCRIPTION: Enter debugger command loop
155 ******************************************************************************/
159 ACPI_WALK_STATE
*WalkState
,
160 ACPI_PARSE_OBJECT
*Op
)
165 /* TBD: [Investigate] are there namespace locking issues here? */
167 /* AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); */
169 /* Go into the command loop and await next user command */
172 AcpiGbl_MethodExecuting
= TRUE
;
173 Status
= AE_CTRL_TRUE
;
174 while (Status
== AE_CTRL_TRUE
)
176 if (AcpiGbl_DebuggerConfiguration
== DEBUGGER_MULTI_THREADED
)
178 /* Handshake with the front-end that gets user command lines */
180 Status
= AcpiUtReleaseMutex (ACPI_MTX_DEBUG_CMD_COMPLETE
);
181 if (ACPI_FAILURE (Status
))
185 Status
= AcpiUtAcquireMutex (ACPI_MTX_DEBUG_CMD_READY
);
186 if (ACPI_FAILURE (Status
))
193 /* Single threaded, we must get a command line ourselves */
195 /* Force output to console until a command is entered */
197 AcpiDbSetOutputDestination (ACPI_DB_CONSOLE_OUTPUT
);
199 /* Different prompt if method is executing */
201 if (!AcpiGbl_MethodExecuting
)
203 AcpiOsPrintf ("%1c ", ACPI_DEBUGGER_COMMAND_PROMPT
);
207 AcpiOsPrintf ("%1c ", ACPI_DEBUGGER_EXECUTE_PROMPT
);
210 /* Get the user input line */
212 (void) AcpiOsGetLine (AcpiGbl_DbLineBuf
);
215 Status
= AcpiDbCommandDispatch (AcpiGbl_DbLineBuf
, WalkState
, Op
);
218 /* AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE); */
224 /*******************************************************************************
226 * FUNCTION: AcpiDbSingleStep
228 * PARAMETERS: WalkState - Current walk
229 * Op - Current executing op (from aml interpreter)
230 * OpcodeClass - Class of the current AML Opcode
234 * DESCRIPTION: Called just before execution of an AML opcode.
236 ******************************************************************************/
240 ACPI_WALK_STATE
*WalkState
,
241 ACPI_PARSE_OBJECT
*Op
,
244 ACPI_PARSE_OBJECT
*Next
;
245 ACPI_STATUS Status
= AE_OK
;
246 UINT32 OriginalDebugLevel
;
247 ACPI_PARSE_OBJECT
*DisplayOp
;
248 ACPI_PARSE_OBJECT
*ParentOp
;
251 ACPI_FUNCTION_ENTRY ();
254 /* Check the abort flag */
256 if (AcpiGbl_AbortMethod
)
258 AcpiGbl_AbortMethod
= FALSE
;
259 return (AE_ABORT_METHOD
);
262 /* Check for single-step breakpoint */
264 if (WalkState
->MethodBreakpoint
&&
265 (WalkState
->MethodBreakpoint
<= Op
->Common
.AmlOffset
))
267 /* Check if the breakpoint has been reached or passed */
268 /* Hit the breakpoint, resume single step, reset breakpoint */
270 AcpiOsPrintf ("***Break*** at AML offset %X\n", Op
->Common
.AmlOffset
);
271 AcpiGbl_CmSingleStep
= TRUE
;
272 AcpiGbl_StepToNextCall
= FALSE
;
273 WalkState
->MethodBreakpoint
= 0;
276 /* Check for user breakpoint (Must be on exact Aml offset) */
278 else if (WalkState
->UserBreakpoint
&&
279 (WalkState
->UserBreakpoint
== Op
->Common
.AmlOffset
))
281 AcpiOsPrintf ("***UserBreakpoint*** at AML offset %X\n",
282 Op
->Common
.AmlOffset
);
283 AcpiGbl_CmSingleStep
= TRUE
;
284 AcpiGbl_StepToNextCall
= FALSE
;
285 WalkState
->MethodBreakpoint
= 0;
289 * Check if this is an opcode that we are interested in --
290 * namely, opcodes that have arguments
292 if (Op
->Common
.AmlOpcode
== AML_INT_NAMEDFIELD_OP
)
299 case AML_CLASS_UNKNOWN
:
300 case AML_CLASS_ARGUMENT
: /* constants, literals, etc. do nothing */
304 /* All other opcodes -- continue */
309 * Under certain debug conditions, display this opcode and its operands
311 if ((AcpiGbl_DbOutputToFile
) ||
312 (AcpiGbl_CmSingleStep
) ||
313 (AcpiDbgLevel
& ACPI_LV_PARSE
))
315 if ((AcpiGbl_DbOutputToFile
) ||
316 (AcpiDbgLevel
& ACPI_LV_PARSE
))
318 AcpiOsPrintf ("\n[AmlDebug] Next AML Opcode to execute:\n");
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)
326 OriginalDebugLevel
= AcpiDbgLevel
;
327 AcpiDbgLevel
&= ~(ACPI_LV_PARSE
| ACPI_LV_FUNCTIONS
);
328 Next
= Op
->Common
.Next
;
329 Op
->Common
.Next
= NULL
;
333 ParentOp
= Op
->Common
.Parent
;
336 if ((WalkState
->ControlState
) &&
337 (WalkState
->ControlState
->Common
.State
==
338 ACPI_CONTROL_PREDICATE_EXECUTING
))
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.
347 if ((ParentOp
->Common
.AmlOpcode
== AML_IF_OP
) ||
348 (ParentOp
->Common
.AmlOpcode
== AML_WHILE_OP
))
350 DisplayOp
= ParentOp
;
353 ParentOp
= ParentOp
->Common
.Parent
;
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
))
368 DisplayOp
= ParentOp
;
369 ParentOp
= ParentOp
->Common
.Parent
;
374 /* Now we can display it */
376 AcpiDmDisassemble (WalkState
, DisplayOp
, ACPI_UINT32_MAX
);
378 if ((Op
->Common
.AmlOpcode
== AML_IF_OP
) ||
379 (Op
->Common
.AmlOpcode
== AML_WHILE_OP
))
381 if (WalkState
->ControlState
->Common
.Value
)
383 AcpiOsPrintf ("Predicate = [True], IF block was executed\n");
387 AcpiOsPrintf ("Predicate = [False], Skipping IF block\n");
390 else if (Op
->Common
.AmlOpcode
== AML_ELSE_OP
)
392 AcpiOsPrintf ("Predicate = [False], ELSE block was executed\n");
395 /* Restore everything */
397 Op
->Common
.Next
= Next
;
399 if ((AcpiGbl_DbOutputToFile
) ||
400 (AcpiDbgLevel
& ACPI_LV_PARSE
))
404 AcpiDbgLevel
= OriginalDebugLevel
;
407 /* If we are not single stepping, just continue executing the method */
409 if (!AcpiGbl_CmSingleStep
)
415 * If we are executing a step-to-call command,
416 * Check if this is a method call.
418 if (AcpiGbl_StepToNextCall
)
420 if (Op
->Common
.AmlOpcode
!= AML_INT_METHODCALL_OP
)
422 /* Not a method call, just keep executing */
427 /* Found a method call, stop executing */
429 AcpiGbl_StepToNextCall
= FALSE
;
433 * If the next opcode is a method call, we will "step over" it
436 if (Op
->Common
.AmlOpcode
== AML_INT_METHODCALL_OP
)
438 /* Force no more single stepping while executing called method */
440 AcpiGbl_CmSingleStep
= FALSE
;
443 * Set the breakpoint on/before the call, it will stop execution
444 * as soon as we return
446 WalkState
->MethodBreakpoint
= 1; /* Must be non-zero! */
450 Status
= AcpiDbStartCommand (WalkState
, Op
);
452 /* User commands complete, continue execution of the interrupted method */
458 /*******************************************************************************
460 * FUNCTION: AcpiDbInitialize
466 * DESCRIPTION: Init and start debugger
468 ******************************************************************************/
479 AcpiGbl_DbBuffer
= NULL
;
480 AcpiGbl_DbFilename
= NULL
;
481 AcpiGbl_DbOutputToFile
= FALSE
;
483 AcpiGbl_DbDebugLevel
= ACPI_LV_VERBOSITY2
;
484 AcpiGbl_DbConsoleDebugLevel
= ACPI_NORMAL_DEFAULT
| ACPI_LV_TABLES
;
485 AcpiGbl_DbOutputFlags
= ACPI_DB_CONSOLE_OUTPUT
;
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
;
493 AcpiGbl_DbBuffer
= AcpiOsAllocate (ACPI_DEBUG_BUFFER_SIZE
);
494 if (!AcpiGbl_DbBuffer
)
496 return (AE_NO_MEMORY
);
498 ACPI_MEMSET (AcpiGbl_DbBuffer
, 0, ACPI_DEBUG_BUFFER_SIZE
);
500 /* Initial scope is the root */
502 AcpiGbl_DbScopeBuf
[0] = '\\';
503 AcpiGbl_DbScopeBuf
[1] = 0;
504 AcpiGbl_DbScopeNode
= AcpiGbl_RootNode
;
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.
511 if (AcpiGbl_DebuggerConfiguration
& DEBUGGER_MULTI_THREADED
)
513 /* These were created with one unit, grab it */
515 Status
= AcpiUtAcquireMutex (ACPI_MTX_DEBUG_CMD_COMPLETE
);
516 if (ACPI_FAILURE (Status
))
518 AcpiOsPrintf ("Could not get debugger mutex\n");
522 Status
= AcpiUtAcquireMutex (ACPI_MTX_DEBUG_CMD_READY
);
523 if (ACPI_FAILURE (Status
))
525 AcpiOsPrintf ("Could not get debugger mutex\n");
529 /* Create the debug execution thread to execute commands */
531 Status
= AcpiOsExecute (OSL_DEBUGGER_THREAD
, AcpiDbExecuteThread
, NULL
);
532 if (ACPI_FAILURE (Status
))
534 AcpiOsPrintf ("Could not start debugger thread\n");
539 if (!AcpiGbl_DbOpt_verbose
)
541 AcpiGbl_DbOpt_disasm
= TRUE
;
542 AcpiGbl_DbOpt_stats
= FALSE
;
549 /*******************************************************************************
551 * FUNCTION: AcpiDbTerminate
557 * DESCRIPTION: Stop debugger
559 ******************************************************************************/
566 if (AcpiGbl_DbBuffer
)
568 AcpiOsFree (AcpiGbl_DbBuffer
);
573 #ifdef ACPI_OBSOLETE_FUNCTIONS
574 /*******************************************************************************
576 * FUNCTION: AcpiDbMethodEnd
578 * PARAMETERS: WalkState - Current walk
582 * DESCRIPTION: Called at method termination
584 ******************************************************************************/
588 ACPI_WALK_STATE
*WalkState
)
591 if (!AcpiGbl_CmSingleStep
)
596 AcpiOsPrintf ("<Method Terminating>\n");
598 AcpiDbStartCommand (WalkState
, NULL
);
602 #endif /* ACPI_DEBUGGER */