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>
159 #define _COMPONENT ACPI_CA_DEBUGGER
160 ACPI_MODULE_NAME ("dbxface")
163 /* Local prototypes */
167 ACPI_WALK_STATE *WalkState,
168 ACPI_PARSE_OBJECT *Op);
170 #ifdef ACPI_OBSOLETE_FUNCTIONS
173 ACPI_WALK_STATE *WalkState);
177 /*******************************************************************************
179 * FUNCTION: AcpiDbStartCommand
181 * PARAMETERS: WalkState - Current walk
182 * Op - Current executing Op, from AML interpreter
186 * DESCRIPTION: Enter debugger command loop
188 ******************************************************************************/
192 ACPI_WALK_STATE *WalkState,
193 ACPI_PARSE_OBJECT *Op)
198 /* TBD: [Investigate] are there namespace locking issues here? */
200 /* AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); */
202 /* Go into the command loop and await next user command */
205 AcpiGbl_MethodExecuting = TRUE;
206 Status = AE_CTRL_TRUE;
208 while (Status == AE_CTRL_TRUE)
210 /* Notify the completion of the command */
212 Status = AcpiOsNotifyCommandComplete ();
213 if (ACPI_FAILURE (Status))
218 /* Wait the readiness of the command */
220 Status = AcpiOsWaitCommandReady ();
221 if (ACPI_FAILURE (Status))
226 Status = AcpiDbCommandDispatch (AcpiGbl_DbLineBuf, WalkState, Op);
229 /* AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE); */
232 if (ACPI_FAILURE (Status) && Status != AE_CTRL_TERMINATE)
234 ACPI_EXCEPTION ((AE_INFO, Status,
235 "While parsing/handling command line"));
241 /*******************************************************************************
243 * FUNCTION: AcpiDbSignalBreakPoint
245 * PARAMETERS: WalkState - Current walk
249 * DESCRIPTION: Called for AML_BREAKPOINT_OP
251 ******************************************************************************/
254 AcpiDbSignalBreakPoint (
255 ACPI_WALK_STATE *WalkState)
258 #ifndef ACPI_APPLICATION
259 if (AcpiGbl_DbThreadId != AcpiOsGetThreadId ())
266 * Set the single-step flag. This will cause the debugger (if present)
267 * to break to the console within the AML debugger at the start of the
268 * next AML instruction.
270 AcpiGbl_CmSingleStep = TRUE;
271 AcpiOsPrintf ("**break** Executed AML BreakPoint opcode\n");
275 /*******************************************************************************
277 * FUNCTION: AcpiDbSingleStep
279 * PARAMETERS: WalkState - Current walk
280 * Op - Current executing op (from aml interpreter)
281 * OpcodeClass - Class of the current AML Opcode
285 * DESCRIPTION: Called just before execution of an AML opcode.
287 ******************************************************************************/
291 ACPI_WALK_STATE *WalkState,
292 ACPI_PARSE_OBJECT *Op,
295 ACPI_PARSE_OBJECT *Next;
296 ACPI_STATUS Status = AE_OK;
297 UINT32 OriginalDebugLevel;
298 ACPI_PARSE_OBJECT *DisplayOp;
299 ACPI_PARSE_OBJECT *ParentOp;
303 ACPI_FUNCTION_ENTRY ();
306 #ifndef ACPI_APPLICATION
307 if (AcpiGbl_DbThreadId != AcpiOsGetThreadId ())
313 /* Check the abort flag */
315 if (AcpiGbl_AbortMethod)
317 AcpiGbl_AbortMethod = FALSE;
318 return (AE_ABORT_METHOD);
321 AmlOffset = (UINT32) ACPI_PTR_DIFF (Op->Common.Aml,
322 WalkState->ParserState.AmlStart);
324 /* Check for single-step breakpoint */
326 if (WalkState->MethodBreakpoint &&
327 (WalkState->MethodBreakpoint <= AmlOffset))
329 /* Check if the breakpoint has been reached or passed */
330 /* Hit the breakpoint, resume single step, reset breakpoint */
332 AcpiOsPrintf ("***Break*** at AML offset %X\n", AmlOffset);
333 AcpiGbl_CmSingleStep = TRUE;
334 AcpiGbl_StepToNextCall = FALSE;
335 WalkState->MethodBreakpoint = 0;
338 /* Check for user breakpoint (Must be on exact Aml offset) */
340 else if (WalkState->UserBreakpoint &&
341 (WalkState->UserBreakpoint == AmlOffset))
343 AcpiOsPrintf ("***UserBreakpoint*** at AML offset %X\n",
345 AcpiGbl_CmSingleStep = TRUE;
346 AcpiGbl_StepToNextCall = FALSE;
347 WalkState->MethodBreakpoint = 0;
351 * Check if this is an opcode that we are interested in --
352 * namely, opcodes that have arguments
354 if (Op->Common.AmlOpcode == AML_INT_NAMEDFIELD_OP)
361 case AML_CLASS_UNKNOWN:
362 case AML_CLASS_ARGUMENT: /* constants, literals, etc. do nothing */
368 /* All other opcodes -- continue */
373 * Under certain debug conditions, display this opcode and its operands
375 if ((AcpiGbl_DbOutputToFile) ||
376 (AcpiGbl_CmSingleStep) ||
377 (AcpiDbgLevel & ACPI_LV_PARSE))
379 if ((AcpiGbl_DbOutputToFile) ||
380 (AcpiDbgLevel & ACPI_LV_PARSE))
382 AcpiOsPrintf ("\nAML Debug: Next AML Opcode to execute:\n");
386 * Display this op (and only this op - zero out the NEXT field
387 * temporarily, and disable parser trace output for the duration of
388 * the display because we don't want the extraneous debug output)
390 OriginalDebugLevel = AcpiDbgLevel;
391 AcpiDbgLevel &= ~(ACPI_LV_PARSE | ACPI_LV_FUNCTIONS);
392 Next = Op->Common.Next;
393 Op->Common.Next = NULL;
397 ParentOp = Op->Common.Parent;
400 if ((WalkState->ControlState) &&
401 (WalkState->ControlState->Common.State ==
402 ACPI_CONTROL_PREDICATE_EXECUTING))
405 * We are executing the predicate of an IF or WHILE statement
406 * Search upwards for the containing IF or WHILE so that the
407 * entire predicate can be displayed.
411 if ((ParentOp->Common.AmlOpcode == AML_IF_OP) ||
412 (ParentOp->Common.AmlOpcode == AML_WHILE_OP))
414 DisplayOp = ParentOp;
417 ParentOp = ParentOp->Common.Parent;
424 if ((ParentOp->Common.AmlOpcode == AML_IF_OP) ||
425 (ParentOp->Common.AmlOpcode == AML_ELSE_OP) ||
426 (ParentOp->Common.AmlOpcode == AML_SCOPE_OP) ||
427 (ParentOp->Common.AmlOpcode == AML_METHOD_OP) ||
428 (ParentOp->Common.AmlOpcode == AML_WHILE_OP))
432 DisplayOp = ParentOp;
433 ParentOp = ParentOp->Common.Parent;
438 /* Now we can display it */
440 #ifdef ACPI_DISASSEMBLER
441 AcpiDmDisassemble (WalkState, DisplayOp, ACPI_UINT32_MAX);
444 if ((Op->Common.AmlOpcode == AML_IF_OP) ||
445 (Op->Common.AmlOpcode == AML_WHILE_OP))
447 if (WalkState->ControlState->Common.Value)
449 AcpiOsPrintf ("Predicate = [True], IF block was executed\n");
453 AcpiOsPrintf ("Predicate = [False], Skipping IF block\n");
456 else if (Op->Common.AmlOpcode == AML_ELSE_OP)
458 AcpiOsPrintf ("Predicate = [False], ELSE block was executed\n");
461 /* Restore everything */
463 Op->Common.Next = Next;
465 if ((AcpiGbl_DbOutputToFile) ||
466 (AcpiDbgLevel & ACPI_LV_PARSE))
470 AcpiDbgLevel = OriginalDebugLevel;
473 /* If we are not single stepping, just continue executing the method */
475 if (!AcpiGbl_CmSingleStep)
481 * If we are executing a step-to-call command,
482 * Check if this is a method call.
484 if (AcpiGbl_StepToNextCall)
486 if (Op->Common.AmlOpcode != AML_INT_METHODCALL_OP)
488 /* Not a method call, just keep executing */
493 /* Found a method call, stop executing */
495 AcpiGbl_StepToNextCall = FALSE;
499 * If the next opcode is a method call, we will "step over" it
502 if (Op->Common.AmlOpcode == AML_INT_METHODCALL_OP)
504 /* Force no more single stepping while executing called method */
506 AcpiGbl_CmSingleStep = FALSE;
509 * Set the breakpoint on/before the call, it will stop execution
510 * as soon as we return
512 WalkState->MethodBreakpoint = 1; /* Must be non-zero! */
516 AcpiExExitInterpreter ();
517 Status = AcpiDbStartCommand (WalkState, Op);
518 AcpiExEnterInterpreter ();
520 /* User commands complete, continue execution of the interrupted method */
526 /*******************************************************************************
528 * FUNCTION: AcpiInitializeDebugger
534 * DESCRIPTION: Init and start debugger
536 ******************************************************************************/
539 AcpiInitializeDebugger (
545 ACPI_FUNCTION_TRACE (AcpiInitializeDebugger);
550 AcpiGbl_DbBuffer = NULL;
551 AcpiGbl_DbFilename = NULL;
552 AcpiGbl_DbOutputToFile = FALSE;
554 AcpiGbl_DbDebugLevel = ACPI_LV_VERBOSITY2;
555 AcpiGbl_DbConsoleDebugLevel = ACPI_NORMAL_DEFAULT | ACPI_LV_TABLES;
556 AcpiGbl_DbOutputFlags = ACPI_DB_CONSOLE_OUTPUT;
558 AcpiGbl_DbOpt_NoIniMethods = FALSE;
560 AcpiGbl_DbBuffer = AcpiOsAllocate (ACPI_DEBUG_BUFFER_SIZE);
561 if (!AcpiGbl_DbBuffer)
563 return_ACPI_STATUS (AE_NO_MEMORY);
565 memset (AcpiGbl_DbBuffer, 0, ACPI_DEBUG_BUFFER_SIZE);
567 /* Initial scope is the root */
569 AcpiGbl_DbScopeBuf [0] = AML_ROOT_PREFIX;
570 AcpiGbl_DbScopeBuf [1] = 0;
571 AcpiGbl_DbScopeNode = AcpiGbl_RootNode;
573 /* Initialize user commands loop */
575 AcpiGbl_DbTerminateLoop = FALSE;
578 * If configured for multi-thread support, the debug executor runs in
579 * a separate thread so that the front end can be in another address
580 * space, environment, or even another machine.
582 if (AcpiGbl_DebuggerConfiguration & DEBUGGER_MULTI_THREADED)
584 /* These were created with one unit, grab it */
586 Status = AcpiOsInitializeDebugger ();
587 if (ACPI_FAILURE (Status))
589 AcpiOsPrintf ("Could not get debugger mutex\n");
590 return_ACPI_STATUS (Status);
593 /* Create the debug execution thread to execute commands */
595 AcpiGbl_DbThreadsTerminated = FALSE;
596 Status = AcpiOsExecute (OSL_DEBUGGER_MAIN_THREAD,
597 AcpiDbExecuteThread, NULL);
598 if (ACPI_FAILURE (Status))
600 ACPI_EXCEPTION ((AE_INFO, Status,
601 "Could not start debugger thread"));
602 AcpiGbl_DbThreadsTerminated = TRUE;
603 return_ACPI_STATUS (Status);
608 AcpiGbl_DbThreadId = AcpiOsGetThreadId ();
611 return_ACPI_STATUS (AE_OK);
614 ACPI_EXPORT_SYMBOL (AcpiInitializeDebugger)
617 /*******************************************************************************
619 * FUNCTION: AcpiTerminateDebugger
625 * DESCRIPTION: Stop debugger
627 ******************************************************************************/
630 AcpiTerminateDebugger (
634 /* Terminate the AML Debugger */
636 AcpiGbl_DbTerminateLoop = TRUE;
638 if (AcpiGbl_DebuggerConfiguration & DEBUGGER_MULTI_THREADED)
640 /* Wait the AML Debugger threads */
642 while (!AcpiGbl_DbThreadsTerminated)
647 AcpiOsTerminateDebugger ();
650 if (AcpiGbl_DbBuffer)
652 AcpiOsFree (AcpiGbl_DbBuffer);
653 AcpiGbl_DbBuffer = NULL;
656 /* Ensure that debug output is now disabled */
658 AcpiGbl_DbOutputFlags = ACPI_DB_DISABLE_OUTPUT;
661 ACPI_EXPORT_SYMBOL (AcpiTerminateDebugger)
664 /*******************************************************************************
666 * FUNCTION: AcpiSetDebuggerThreadId
668 * PARAMETERS: ThreadId - Debugger thread ID
672 * DESCRIPTION: Set debugger thread ID
674 ******************************************************************************/
677 AcpiSetDebuggerThreadId (
678 ACPI_THREAD_ID ThreadId)
680 AcpiGbl_DbThreadId = ThreadId;
683 ACPI_EXPORT_SYMBOL (AcpiSetDebuggerThreadId)