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 *****************************************************************************/
152 #include <contrib/dev/acpica/include/acpi.h>
153 #include <contrib/dev/acpica/include/accommon.h>
154 #include <contrib/dev/acpica/include/amlcode.h>
155 #include <contrib/dev/acpica/include/acdebug.h>
156 #include <contrib/dev/acpica/include/acinterp.h>
157 #include <contrib/dev/acpica/include/acparser.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);
177 #ifdef ACPI_DISASSEMBLER
178 static ACPI_PARSE_OBJECT *
180 ACPI_WALK_STATE *WalkState,
181 ACPI_PARSE_OBJECT *Op);
184 /*******************************************************************************
186 * FUNCTION: AcpiDbStartCommand
188 * PARAMETERS: WalkState - Current walk
189 * Op - Current executing Op, from AML interpreter
193 * DESCRIPTION: Enter debugger command loop
195 ******************************************************************************/
199 ACPI_WALK_STATE *WalkState,
200 ACPI_PARSE_OBJECT *Op)
205 /* TBD: [Investigate] are there namespace locking issues here? */
207 /* AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); */
209 /* Go into the command loop and await next user command */
212 AcpiGbl_MethodExecuting = TRUE;
213 Status = AE_CTRL_TRUE;
215 while (Status == AE_CTRL_TRUE)
217 /* Notify the completion of the command */
219 Status = AcpiOsNotifyCommandComplete ();
220 if (ACPI_FAILURE (Status))
225 /* Wait the readiness of the command */
227 Status = AcpiOsWaitCommandReady ();
228 if (ACPI_FAILURE (Status))
233 Status = AcpiDbCommandDispatch (AcpiGbl_DbLineBuf, WalkState, Op);
236 /* AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE); */
239 if (ACPI_FAILURE (Status) && Status != AE_CTRL_TERMINATE)
241 ACPI_EXCEPTION ((AE_INFO, Status,
242 "While parsing/handling command line"));
248 /*******************************************************************************
250 * FUNCTION: AcpiDbSignalBreakPoint
252 * PARAMETERS: WalkState - Current walk
256 * DESCRIPTION: Called for AML_BREAKPOINT_OP
258 ******************************************************************************/
261 AcpiDbSignalBreakPoint (
262 ACPI_WALK_STATE *WalkState)
265 #ifndef ACPI_APPLICATION
266 if (AcpiGbl_DbThreadId != AcpiOsGetThreadId ())
273 * Set the single-step flag. This will cause the debugger (if present)
274 * to break to the console within the AML debugger at the start of the
275 * next AML instruction.
277 AcpiGbl_CmSingleStep = TRUE;
278 AcpiOsPrintf ("**break** Executed AML BreakPoint opcode\n");
282 #ifdef ACPI_DISASSEMBLER
283 /*******************************************************************************
285 * FUNCTION: AcpiDbGetDisplayOp
287 * PARAMETERS: WalkState - Current walk
288 * Op - Current executing op (from aml interpreter)
290 * RETURN: Opcode to display
292 * DESCRIPTION: Find the opcode to display during single stepping
294 ******************************************************************************/
296 static ACPI_PARSE_OBJECT *
298 ACPI_WALK_STATE *WalkState,
299 ACPI_PARSE_OBJECT *Op)
301 ACPI_PARSE_OBJECT *DisplayOp;
302 ACPI_PARSE_OBJECT *ParentOp;
305 ParentOp = Op->Common.Parent;
308 if ((WalkState->ControlState) &&
309 (WalkState->ControlState->Common.State ==
310 ACPI_CONTROL_PREDICATE_EXECUTING))
313 * We are executing the predicate of an IF or WHILE statement
314 * Search upwards for the containing IF or WHILE so that the
315 * entire predicate can be displayed.
319 if ((ParentOp->Common.AmlOpcode == AML_IF_OP) ||
320 (ParentOp->Common.AmlOpcode == AML_WHILE_OP))
322 DisplayOp = ParentOp;
325 ParentOp = ParentOp->Common.Parent;
332 if ((ParentOp->Common.AmlOpcode == AML_IF_OP) ||
333 (ParentOp->Common.AmlOpcode == AML_ELSE_OP) ||
334 (ParentOp->Common.AmlOpcode == AML_SCOPE_OP) ||
335 (ParentOp->Common.AmlOpcode == AML_METHOD_OP) ||
336 (ParentOp->Common.AmlOpcode == AML_WHILE_OP))
340 DisplayOp = ParentOp;
341 ParentOp = ParentOp->Common.Parent;
350 /*******************************************************************************
352 * FUNCTION: AcpiDbSingleStep
354 * PARAMETERS: WalkState - Current walk
355 * Op - Current executing op (from aml interpreter)
356 * OpcodeClass - Class of the current AML Opcode
360 * DESCRIPTION: Called just before execution of an AML opcode.
362 ******************************************************************************/
366 ACPI_WALK_STATE *WalkState,
367 ACPI_PARSE_OBJECT *Op,
370 ACPI_PARSE_OBJECT *Next;
371 ACPI_STATUS Status = AE_OK;
372 UINT32 OriginalDebugLevel;
376 ACPI_FUNCTION_ENTRY ();
379 #ifndef ACPI_APPLICATION
380 if (AcpiGbl_DbThreadId != AcpiOsGetThreadId ())
386 /* Check the abort flag */
388 if (AcpiGbl_AbortMethod)
390 AcpiGbl_AbortMethod = FALSE;
391 return (AE_ABORT_METHOD);
394 AmlOffset = (UINT32) ACPI_PTR_DIFF (Op->Common.Aml,
395 WalkState->ParserState.AmlStart);
397 /* Check for single-step breakpoint */
399 if (WalkState->MethodBreakpoint &&
400 (WalkState->MethodBreakpoint <= AmlOffset))
402 /* Check if the breakpoint has been reached or passed */
403 /* Hit the breakpoint, resume single step, reset breakpoint */
405 AcpiOsPrintf ("***Break*** at AML offset %X\n", AmlOffset);
406 AcpiGbl_CmSingleStep = TRUE;
407 AcpiGbl_StepToNextCall = FALSE;
408 WalkState->MethodBreakpoint = 0;
411 /* Check for user breakpoint (Must be on exact Aml offset) */
413 else if (WalkState->UserBreakpoint &&
414 (WalkState->UserBreakpoint == AmlOffset))
416 AcpiOsPrintf ("***UserBreakpoint*** at AML offset %X\n",
418 AcpiGbl_CmSingleStep = TRUE;
419 AcpiGbl_StepToNextCall = FALSE;
420 WalkState->MethodBreakpoint = 0;
424 * Check if this is an opcode that we are interested in --
425 * namely, opcodes that have arguments
427 if (Op->Common.AmlOpcode == AML_INT_NAMEDFIELD_OP)
434 case AML_CLASS_UNKNOWN:
435 case AML_CLASS_ARGUMENT: /* constants, literals, etc. do nothing */
441 /* All other opcodes -- continue */
446 * Under certain debug conditions, display this opcode and its operands
448 if ((AcpiGbl_DbOutputToFile) ||
449 (AcpiGbl_CmSingleStep) ||
450 (AcpiDbgLevel & ACPI_LV_PARSE))
452 if ((AcpiGbl_DbOutputToFile) ||
453 (AcpiDbgLevel & ACPI_LV_PARSE))
455 AcpiOsPrintf ("\nAML Debug: Next AML Opcode to execute:\n");
459 * Display this op (and only this op - zero out the NEXT field
460 * temporarily, and disable parser trace output for the duration of
461 * the display because we don't want the extraneous debug output)
463 OriginalDebugLevel = AcpiDbgLevel;
464 AcpiDbgLevel &= ~(ACPI_LV_PARSE | ACPI_LV_FUNCTIONS);
465 Next = Op->Common.Next;
466 Op->Common.Next = NULL;
468 /* Now we can disassemble and display it */
470 #ifdef ACPI_DISASSEMBLER
471 AcpiDmDisassemble (WalkState, AcpiDbGetDisplayOp (WalkState, Op),
475 * The AML Disassembler is not configured - at least we can
476 * display the opcode value and name
478 AcpiOsPrintf ("AML Opcode: %4.4X %s\n", Op->Common.AmlOpcode,
479 AcpiPsGetOpcodeName (Op->Common.AmlOpcode));
482 if ((Op->Common.AmlOpcode == AML_IF_OP) ||
483 (Op->Common.AmlOpcode == AML_WHILE_OP))
485 if (WalkState->ControlState->Common.Value)
487 AcpiOsPrintf ("Predicate = [True], IF block was executed\n");
491 AcpiOsPrintf ("Predicate = [False], Skipping IF block\n");
494 else if (Op->Common.AmlOpcode == AML_ELSE_OP)
496 AcpiOsPrintf ("Predicate = [False], ELSE block was executed\n");
499 /* Restore everything */
501 Op->Common.Next = Next;
503 if ((AcpiGbl_DbOutputToFile) ||
504 (AcpiDbgLevel & ACPI_LV_PARSE))
508 AcpiDbgLevel = OriginalDebugLevel;
511 /* If we are not single stepping, just continue executing the method */
513 if (!AcpiGbl_CmSingleStep)
519 * If we are executing a step-to-call command,
520 * Check if this is a method call.
522 if (AcpiGbl_StepToNextCall)
524 if (Op->Common.AmlOpcode != AML_INT_METHODCALL_OP)
526 /* Not a method call, just keep executing */
531 /* Found a method call, stop executing */
533 AcpiGbl_StepToNextCall = FALSE;
537 * If the next opcode is a method call, we will "step over" it
540 if (Op->Common.AmlOpcode == AML_INT_METHODCALL_OP)
542 /* Force no more single stepping while executing called method */
544 AcpiGbl_CmSingleStep = FALSE;
547 * Set the breakpoint on/before the call, it will stop execution
548 * as soon as we return
550 WalkState->MethodBreakpoint = 1; /* Must be non-zero! */
554 AcpiExExitInterpreter ();
555 Status = AcpiDbStartCommand (WalkState, Op);
556 AcpiExEnterInterpreter ();
558 /* User commands complete, continue execution of the interrupted method */
564 /*******************************************************************************
566 * FUNCTION: AcpiInitializeDebugger
572 * DESCRIPTION: Init and start debugger
574 ******************************************************************************/
577 AcpiInitializeDebugger (
583 ACPI_FUNCTION_TRACE (AcpiInitializeDebugger);
588 AcpiGbl_DbBuffer = NULL;
589 AcpiGbl_DbFilename = NULL;
590 AcpiGbl_DbOutputToFile = FALSE;
592 AcpiGbl_DbDebugLevel = ACPI_LV_VERBOSITY2;
593 AcpiGbl_DbConsoleDebugLevel = ACPI_NORMAL_DEFAULT | ACPI_LV_TABLES;
594 AcpiGbl_DbOutputFlags = ACPI_DB_CONSOLE_OUTPUT;
596 AcpiGbl_DbOpt_NoIniMethods = FALSE;
598 AcpiGbl_DbBuffer = AcpiOsAllocate (ACPI_DEBUG_BUFFER_SIZE);
599 if (!AcpiGbl_DbBuffer)
601 return_ACPI_STATUS (AE_NO_MEMORY);
603 memset (AcpiGbl_DbBuffer, 0, ACPI_DEBUG_BUFFER_SIZE);
605 /* Initial scope is the root */
607 AcpiGbl_DbScopeBuf [0] = AML_ROOT_PREFIX;
608 AcpiGbl_DbScopeBuf [1] = 0;
609 AcpiGbl_DbScopeNode = AcpiGbl_RootNode;
611 /* Initialize user commands loop */
613 AcpiGbl_DbTerminateLoop = FALSE;
616 * If configured for multi-thread support, the debug executor runs in
617 * a separate thread so that the front end can be in another address
618 * space, environment, or even another machine.
620 if (AcpiGbl_DebuggerConfiguration & DEBUGGER_MULTI_THREADED)
622 /* These were created with one unit, grab it */
624 Status = AcpiOsInitializeDebugger ();
625 if (ACPI_FAILURE (Status))
627 AcpiOsPrintf ("Could not get debugger mutex\n");
628 return_ACPI_STATUS (Status);
631 /* Create the debug execution thread to execute commands */
633 AcpiGbl_DbThreadsTerminated = FALSE;
634 Status = AcpiOsExecute (OSL_DEBUGGER_MAIN_THREAD,
635 AcpiDbExecuteThread, NULL);
636 if (ACPI_FAILURE (Status))
638 ACPI_EXCEPTION ((AE_INFO, Status,
639 "Could not start debugger thread"));
640 AcpiGbl_DbThreadsTerminated = TRUE;
641 return_ACPI_STATUS (Status);
646 AcpiGbl_DbThreadId = AcpiOsGetThreadId ();
649 return_ACPI_STATUS (AE_OK);
652 ACPI_EXPORT_SYMBOL (AcpiInitializeDebugger)
655 /*******************************************************************************
657 * FUNCTION: AcpiTerminateDebugger
663 * DESCRIPTION: Stop debugger
665 ******************************************************************************/
668 AcpiTerminateDebugger (
672 /* Terminate the AML Debugger */
674 AcpiGbl_DbTerminateLoop = TRUE;
676 if (AcpiGbl_DebuggerConfiguration & DEBUGGER_MULTI_THREADED)
678 /* Wait the AML Debugger threads */
680 while (!AcpiGbl_DbThreadsTerminated)
685 AcpiOsTerminateDebugger ();
688 if (AcpiGbl_DbBuffer)
690 AcpiOsFree (AcpiGbl_DbBuffer);
691 AcpiGbl_DbBuffer = NULL;
694 /* Ensure that debug output is now disabled */
696 AcpiGbl_DbOutputFlags = ACPI_DB_DISABLE_OUTPUT;
699 ACPI_EXPORT_SYMBOL (AcpiTerminateDebugger)
702 /*******************************************************************************
704 * FUNCTION: AcpiSetDebuggerThreadId
706 * PARAMETERS: ThreadId - Debugger thread ID
710 * DESCRIPTION: Set debugger thread ID
712 ******************************************************************************/
715 AcpiSetDebuggerThreadId (
716 ACPI_THREAD_ID ThreadId)
718 AcpiGbl_DbThreadId = ThreadId;
721 ACPI_EXPORT_SYMBOL (AcpiSetDebuggerThreadId)