1 /*******************************************************************************
3 * Module Name: dbxface - AML Debugger external interfaces
5 ******************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2018, 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 *****************************************************************************
116 * Alternatively, you may choose to be licensed under the terms of the
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
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.
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.
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.
150 *****************************************************************************/
153 #include "accommon.h"
156 #include "acinterp.h"
160 #define _COMPONENT ACPI_CA_DEBUGGER
161 ACPI_MODULE_NAME ("dbxface")
164 /* Local prototypes */
168 ACPI_WALK_STATE
*WalkState
,
169 ACPI_PARSE_OBJECT
*Op
);
171 #ifdef ACPI_OBSOLETE_FUNCTIONS
174 ACPI_WALK_STATE
*WalkState
);
178 /*******************************************************************************
180 * FUNCTION: AcpiDbStartCommand
182 * PARAMETERS: WalkState - Current walk
183 * Op - Current executing Op, from AML interpreter
187 * DESCRIPTION: Enter debugger command loop
189 ******************************************************************************/
193 ACPI_WALK_STATE
*WalkState
,
194 ACPI_PARSE_OBJECT
*Op
)
199 /* TBD: [Investigate] are there namespace locking issues here? */
201 /* AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); */
203 /* Go into the command loop and await next user command */
206 AcpiGbl_MethodExecuting
= TRUE
;
207 Status
= AE_CTRL_TRUE
;
209 while (Status
== AE_CTRL_TRUE
)
211 /* Notify the completion of the command */
213 Status
= AcpiOsNotifyCommandComplete ();
214 if (ACPI_FAILURE (Status
))
219 /* Wait the readiness of the command */
221 Status
= AcpiOsWaitCommandReady ();
222 if (ACPI_FAILURE (Status
))
227 Status
= AcpiDbCommandDispatch (AcpiGbl_DbLineBuf
, WalkState
, Op
);
230 /* AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE); */
233 if (ACPI_FAILURE (Status
) && Status
!= AE_CTRL_TERMINATE
)
235 ACPI_EXCEPTION ((AE_INFO
, Status
,
236 "While parsing/handling command line"));
242 /*******************************************************************************
244 * FUNCTION: AcpiDbSignalBreakPoint
246 * PARAMETERS: WalkState - Current walk
250 * DESCRIPTION: Called for AML_BREAKPOINT_OP
252 ******************************************************************************/
255 AcpiDbSignalBreakPoint (
256 ACPI_WALK_STATE
*WalkState
)
259 #ifndef ACPI_APPLICATION
260 if (AcpiGbl_DbThreadId
!= AcpiOsGetThreadId ())
267 * Set the single-step flag. This will cause the debugger (if present)
268 * to break to the console within the AML debugger at the start of the
269 * next AML instruction.
271 AcpiGbl_CmSingleStep
= TRUE
;
272 AcpiOsPrintf ("**break** Executed AML BreakPoint opcode\n");
276 /*******************************************************************************
278 * FUNCTION: AcpiDbSingleStep
280 * PARAMETERS: WalkState - Current walk
281 * Op - Current executing op (from aml interpreter)
282 * OpcodeClass - Class of the current AML Opcode
286 * DESCRIPTION: Called just before execution of an AML opcode.
288 ******************************************************************************/
292 ACPI_WALK_STATE
*WalkState
,
293 ACPI_PARSE_OBJECT
*Op
,
296 ACPI_PARSE_OBJECT
*Next
;
297 ACPI_STATUS Status
= AE_OK
;
298 UINT32 OriginalDebugLevel
;
299 ACPI_PARSE_OBJECT
*DisplayOp
;
300 ACPI_PARSE_OBJECT
*ParentOp
;
304 ACPI_FUNCTION_ENTRY ();
307 #ifndef ACPI_APPLICATION
308 if (AcpiGbl_DbThreadId
!= AcpiOsGetThreadId ())
314 /* Check the abort flag */
316 if (AcpiGbl_AbortMethod
)
318 AcpiGbl_AbortMethod
= FALSE
;
319 return (AE_ABORT_METHOD
);
322 AmlOffset
= (UINT32
) ACPI_PTR_DIFF (Op
->Common
.Aml
,
323 WalkState
->ParserState
.AmlStart
);
325 /* Check for single-step breakpoint */
327 if (WalkState
->MethodBreakpoint
&&
328 (WalkState
->MethodBreakpoint
<= AmlOffset
))
330 /* Check if the breakpoint has been reached or passed */
331 /* Hit the breakpoint, resume single step, reset breakpoint */
333 AcpiOsPrintf ("***Break*** at AML offset %X\n", AmlOffset
);
334 AcpiGbl_CmSingleStep
= TRUE
;
335 AcpiGbl_StepToNextCall
= FALSE
;
336 WalkState
->MethodBreakpoint
= 0;
339 /* Check for user breakpoint (Must be on exact Aml offset) */
341 else if (WalkState
->UserBreakpoint
&&
342 (WalkState
->UserBreakpoint
== AmlOffset
))
344 AcpiOsPrintf ("***UserBreakpoint*** at AML offset %X\n",
346 AcpiGbl_CmSingleStep
= TRUE
;
347 AcpiGbl_StepToNextCall
= FALSE
;
348 WalkState
->MethodBreakpoint
= 0;
352 * Check if this is an opcode that we are interested in --
353 * namely, opcodes that have arguments
355 if (Op
->Common
.AmlOpcode
== AML_INT_NAMEDFIELD_OP
)
362 case AML_CLASS_UNKNOWN
:
363 case AML_CLASS_ARGUMENT
: /* constants, literals, etc. do nothing */
369 /* All other opcodes -- continue */
374 * Under certain debug conditions, display this opcode and its operands
376 if ((AcpiGbl_DbOutputToFile
) ||
377 (AcpiGbl_CmSingleStep
) ||
378 (AcpiDbgLevel
& ACPI_LV_PARSE
))
380 if ((AcpiGbl_DbOutputToFile
) ||
381 (AcpiDbgLevel
& ACPI_LV_PARSE
))
383 AcpiOsPrintf ("\nAML Debug: Next AML Opcode to execute:\n");
387 * Display this op (and only this op - zero out the NEXT field
388 * temporarily, and disable parser trace output for the duration of
389 * the display because we don't want the extraneous debug output)
391 OriginalDebugLevel
= AcpiDbgLevel
;
392 AcpiDbgLevel
&= ~(ACPI_LV_PARSE
| ACPI_LV_FUNCTIONS
);
393 Next
= Op
->Common
.Next
;
394 Op
->Common
.Next
= NULL
;
398 ParentOp
= Op
->Common
.Parent
;
401 if ((WalkState
->ControlState
) &&
402 (WalkState
->ControlState
->Common
.State
==
403 ACPI_CONTROL_PREDICATE_EXECUTING
))
406 * We are executing the predicate of an IF or WHILE statement
407 * Search upwards for the containing IF or WHILE so that the
408 * entire predicate can be displayed.
412 if ((ParentOp
->Common
.AmlOpcode
== AML_IF_OP
) ||
413 (ParentOp
->Common
.AmlOpcode
== AML_WHILE_OP
))
415 DisplayOp
= ParentOp
;
418 ParentOp
= ParentOp
->Common
.Parent
;
425 if ((ParentOp
->Common
.AmlOpcode
== AML_IF_OP
) ||
426 (ParentOp
->Common
.AmlOpcode
== AML_ELSE_OP
) ||
427 (ParentOp
->Common
.AmlOpcode
== AML_SCOPE_OP
) ||
428 (ParentOp
->Common
.AmlOpcode
== AML_METHOD_OP
) ||
429 (ParentOp
->Common
.AmlOpcode
== AML_WHILE_OP
))
433 DisplayOp
= ParentOp
;
434 ParentOp
= ParentOp
->Common
.Parent
;
439 /* Now we can display it */
441 #ifdef ACPI_DISASSEMBLER
442 AcpiDmDisassemble (WalkState
, DisplayOp
, ACPI_UINT32_MAX
);
445 if ((Op
->Common
.AmlOpcode
== AML_IF_OP
) ||
446 (Op
->Common
.AmlOpcode
== AML_WHILE_OP
))
448 if (WalkState
->ControlState
->Common
.Value
)
450 AcpiOsPrintf ("Predicate = [True], IF block was executed\n");
454 AcpiOsPrintf ("Predicate = [False], Skipping IF block\n");
457 else if (Op
->Common
.AmlOpcode
== AML_ELSE_OP
)
459 AcpiOsPrintf ("Predicate = [False], ELSE block was executed\n");
462 /* Restore everything */
464 Op
->Common
.Next
= Next
;
466 if ((AcpiGbl_DbOutputToFile
) ||
467 (AcpiDbgLevel
& ACPI_LV_PARSE
))
471 AcpiDbgLevel
= OriginalDebugLevel
;
474 /* If we are not single stepping, just continue executing the method */
476 if (!AcpiGbl_CmSingleStep
)
482 * If we are executing a step-to-call command,
483 * Check if this is a method call.
485 if (AcpiGbl_StepToNextCall
)
487 if (Op
->Common
.AmlOpcode
!= AML_INT_METHODCALL_OP
)
489 /* Not a method call, just keep executing */
494 /* Found a method call, stop executing */
496 AcpiGbl_StepToNextCall
= FALSE
;
500 * If the next opcode is a method call, we will "step over" it
503 if (Op
->Common
.AmlOpcode
== AML_INT_METHODCALL_OP
)
505 /* Force no more single stepping while executing called method */
507 AcpiGbl_CmSingleStep
= FALSE
;
510 * Set the breakpoint on/before the call, it will stop execution
511 * as soon as we return
513 WalkState
->MethodBreakpoint
= 1; /* Must be non-zero! */
517 AcpiExExitInterpreter ();
518 Status
= AcpiDbStartCommand (WalkState
, Op
);
519 AcpiExEnterInterpreter ();
521 /* User commands complete, continue execution of the interrupted method */
527 /*******************************************************************************
529 * FUNCTION: AcpiInitializeDebugger
535 * DESCRIPTION: Init and start debugger
537 ******************************************************************************/
540 AcpiInitializeDebugger (
546 ACPI_FUNCTION_TRACE (AcpiInitializeDebugger
);
551 AcpiGbl_DbBuffer
= NULL
;
552 AcpiGbl_DbFilename
= NULL
;
553 AcpiGbl_DbOutputToFile
= FALSE
;
555 AcpiGbl_DbDebugLevel
= ACPI_LV_VERBOSITY2
;
556 AcpiGbl_DbConsoleDebugLevel
= ACPI_NORMAL_DEFAULT
| ACPI_LV_TABLES
;
557 AcpiGbl_DbOutputFlags
= ACPI_DB_CONSOLE_OUTPUT
;
559 AcpiGbl_DbOpt_NoIniMethods
= FALSE
;
561 AcpiGbl_DbBuffer
= AcpiOsAllocate (ACPI_DEBUG_BUFFER_SIZE
);
562 if (!AcpiGbl_DbBuffer
)
564 return_ACPI_STATUS (AE_NO_MEMORY
);
566 memset (AcpiGbl_DbBuffer
, 0, ACPI_DEBUG_BUFFER_SIZE
);
568 /* Initial scope is the root */
570 AcpiGbl_DbScopeBuf
[0] = AML_ROOT_PREFIX
;
571 AcpiGbl_DbScopeBuf
[1] = 0;
572 AcpiGbl_DbScopeNode
= AcpiGbl_RootNode
;
574 /* Initialize user commands loop */
576 AcpiGbl_DbTerminateLoop
= FALSE
;
579 * If configured for multi-thread support, the debug executor runs in
580 * a separate thread so that the front end can be in another address
581 * space, environment, or even another machine.
583 if (AcpiGbl_DebuggerConfiguration
& DEBUGGER_MULTI_THREADED
)
585 /* These were created with one unit, grab it */
587 Status
= AcpiOsInitializeDebugger ();
588 if (ACPI_FAILURE (Status
))
590 AcpiOsPrintf ("Could not get debugger mutex\n");
591 return_ACPI_STATUS (Status
);
594 /* Create the debug execution thread to execute commands */
596 AcpiGbl_DbThreadsTerminated
= FALSE
;
597 Status
= AcpiOsExecute (OSL_DEBUGGER_MAIN_THREAD
,
598 AcpiDbExecuteThread
, NULL
);
599 if (ACPI_FAILURE (Status
))
601 ACPI_EXCEPTION ((AE_INFO
, Status
,
602 "Could not start debugger thread"));
603 AcpiGbl_DbThreadsTerminated
= TRUE
;
604 return_ACPI_STATUS (Status
);
609 AcpiGbl_DbThreadId
= AcpiOsGetThreadId ();
612 return_ACPI_STATUS (AE_OK
);
615 ACPI_EXPORT_SYMBOL (AcpiInitializeDebugger
)
618 /*******************************************************************************
620 * FUNCTION: AcpiTerminateDebugger
626 * DESCRIPTION: Stop debugger
628 ******************************************************************************/
631 AcpiTerminateDebugger (
635 /* Terminate the AML Debugger */
637 AcpiGbl_DbTerminateLoop
= TRUE
;
639 if (AcpiGbl_DebuggerConfiguration
& DEBUGGER_MULTI_THREADED
)
641 /* Wait the AML Debugger threads */
643 while (!AcpiGbl_DbThreadsTerminated
)
648 AcpiOsTerminateDebugger ();
651 if (AcpiGbl_DbBuffer
)
653 AcpiOsFree (AcpiGbl_DbBuffer
);
654 AcpiGbl_DbBuffer
= NULL
;
657 /* Ensure that debug output is now disabled */
659 AcpiGbl_DbOutputFlags
= ACPI_DB_DISABLE_OUTPUT
;
662 ACPI_EXPORT_SYMBOL (AcpiTerminateDebugger
)
665 /*******************************************************************************
667 * FUNCTION: AcpiSetDebuggerThreadId
669 * PARAMETERS: ThreadId - Debugger thread ID
673 * DESCRIPTION: Set debugger thread ID
675 ******************************************************************************/
678 AcpiSetDebuggerThreadId (
679 ACPI_THREAD_ID ThreadId
)
681 AcpiGbl_DbThreadId
= ThreadId
;
684 ACPI_EXPORT_SYMBOL (AcpiSetDebuggerThreadId
)
686 #endif /* ACPI_DEBUGGER */