1 /*******************************************************************************
3 * Module Name: dbinput - user front-end to the AML debugger
6 ******************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2003, Intel Corp.
13 * All rights reserved.
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
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
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;
38 * The above copyright and patent license is granted only if the following
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.
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
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
73 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
81 * 4. Disclaimer and Export Compliance
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
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
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.
115 *****************************************************************************/
124 #define _COMPONENT ACPI_CA_DEBUGGER
125 ACPI_MODULE_NAME ("dbinput")
129 * Top-level debugger commands.
131 * This list of commands must match the string table below it
133 enum AcpiExDebuggerCommands
188 #define CMD_FIRST_VALID 2
191 static const COMMAND_INFO AcpiGbl_DbCommands[] =
248 /*******************************************************************************
250 * FUNCTION: AcpiDbDisplayHelp
252 * PARAMETERS: HelpType - Subcommand (optional)
256 * DESCRIPTION: Print a usage message.
258 ******************************************************************************/
266 /* No parameter, just give the overview */
270 AcpiOsPrintf ("ACPI CA Debugger Commands\n\n");
271 AcpiOsPrintf ("The following classes of commands are available. Help is available for\n");
272 AcpiOsPrintf ("each class by entering \"Help <ClassName>\"\n\n");
273 AcpiOsPrintf (" [GENERAL] General-Purpose Commands\n");
274 AcpiOsPrintf (" [NAMESPACE] Namespace Access Commands\n");
275 AcpiOsPrintf (" [METHOD] Control Method Execution Commands\n");
276 AcpiOsPrintf (" [FILE] File I/O Commands\n");
281 * Parameter is the command class
283 * The idea here is to keep each class of commands smaller than a screenful
288 AcpiOsPrintf ("\nGeneral-Purpose Commands\n\n");
289 AcpiOsPrintf ("Allocations Display list of current memory allocations\n");
290 AcpiOsPrintf ("Dump <Address>|<Namepath>\n");
291 AcpiOsPrintf (" [Byte|Word|Dword|Qword] Display ACPI objects or memory\n");
292 AcpiOsPrintf ("EnableAcpi Enable ACPI (hardware) mode\n");
293 AcpiOsPrintf ("Help This help screen\n");
294 AcpiOsPrintf ("History Display command history buffer\n");
295 AcpiOsPrintf ("Level [<DebugLevel>] [console] Get/Set debug level for file or console\n");
296 AcpiOsPrintf ("Locks Current status of internal mutexes\n");
297 AcpiOsPrintf ("Quit or Exit Exit this command\n");
298 AcpiOsPrintf ("Stats [Allocations|Memory|Misc\n");
299 AcpiOsPrintf (" |Objects|Tables] Display namespace and memory statistics\n");
300 AcpiOsPrintf ("Tables Display info about loaded ACPI tables\n");
301 AcpiOsPrintf ("Unload <TableSig> [Instance] Unload an ACPI table\n");
302 AcpiOsPrintf ("! <CommandNumber> Execute command from history buffer\n");
303 AcpiOsPrintf ("!! Execute last command again\n");
307 AcpiOsPrintf ("\nNamespace Access Commands\n\n");
308 AcpiOsPrintf ("Event <F|G> <Value> Generate AcpiEvent (Fixed/GPE)\n");
309 AcpiOsPrintf ("Find <Name> (? is wildcard) Find ACPI name(s) with wildcards\n");
310 AcpiOsPrintf ("Method Display list of loaded control methods\n");
311 AcpiOsPrintf ("Namespace [<Addr>|<Path>] [Depth] Display loaded namespace tree/subtree\n");
312 AcpiOsPrintf ("Notify <NamePath> <Value> Send a notification\n");
313 AcpiOsPrintf ("Objects <ObjectType> Display all objects of the given type\n");
314 AcpiOsPrintf ("Owner <OwnerId> [Depth] Display loaded namespace by object owner\n");
315 AcpiOsPrintf ("Prefix [<NamePath>] Set or Get current execution prefix\n");
316 AcpiOsPrintf ("References <Addr> Find all references to object at addr\n");
317 AcpiOsPrintf ("Resources xxx Get and display resources\n");
318 AcpiOsPrintf ("Terminate Delete namespace and all internal objects\n");
319 AcpiOsPrintf ("Thread <Threads><Loops><NamePath> Spawn threads to execute method(s)\n");
323 AcpiOsPrintf ("\nControl Method Execution Commands\n\n");
324 AcpiOsPrintf ("Arguments (or Args) Display method arguments\n");
325 AcpiOsPrintf ("Breakpoint <AmlOffset> Set an AML execution breakpoint\n");
326 AcpiOsPrintf ("Call Run to next control method invocation\n");
327 AcpiOsPrintf ("Debug <Namepath> [Arguments] Single Step a control method\n");
328 AcpiOsPrintf ("Execute <Namepath> [Arguments] Execute control method\n");
329 AcpiOsPrintf ("Go Allow method to run to completion\n");
330 AcpiOsPrintf ("Information Display info about the current method\n");
331 AcpiOsPrintf ("Into Step into (not over) a method call\n");
332 AcpiOsPrintf ("List [# of Aml Opcodes] Display method ASL statements\n");
333 AcpiOsPrintf ("Locals Display method local variables\n");
334 AcpiOsPrintf ("Results Display method result stack\n");
335 AcpiOsPrintf ("Set <A|L> <#> <Value> Set method data (Arguments/Locals)\n");
336 AcpiOsPrintf ("Stop Terminate control method\n");
337 AcpiOsPrintf ("Tree Display control method calling tree\n");
338 AcpiOsPrintf ("<Enter> Single step next AML opcode (over calls)\n");
342 AcpiOsPrintf ("\nFile I/O Commands\n\n");
343 AcpiOsPrintf ("Close Close debug output file\n");
344 AcpiOsPrintf ("Open <Output Filename> Open a file for debug output\n");
345 AcpiOsPrintf ("Load <Input Filename> Load ACPI table from a file\n");
349 AcpiOsPrintf ("Unrecognized Command Class: %s\n", HelpType);
355 /*******************************************************************************
357 * FUNCTION: AcpiDbGetNextToken
359 * PARAMETERS: String - Command buffer
360 * Next - Return value, end of next token
362 * RETURN: Pointer to the start of the next token.
364 * DESCRIPTION: Command line parsing. Get the next token on the command line
366 ******************************************************************************/
376 /* At end of buffer? */
378 if (!String || !(*String))
383 /* Get rid of any spaces at the beginning */
387 while (*String && (*String == ' '))
400 /* Find end of token */
402 while (*String && (*String != ' '))
421 /*******************************************************************************
423 * FUNCTION: AcpiDbGetLine
425 * PARAMETERS: InputBuffer - Command line buffer
429 * DESCRIPTION: Get the next command line from the user. Gets entire line
430 * up to the next newline
432 ******************************************************************************/
444 ACPI_STRCPY (AcpiGbl_DbParsedBuf, InputBuffer);
445 ACPI_STRUPR (AcpiGbl_DbParsedBuf);
447 This = AcpiGbl_DbParsedBuf;
448 for (i = 0; i < ACPI_DEBUGGER_MAX_ARGS; i++)
450 AcpiGbl_DbArgs[i] = AcpiDbGetNextToken (This, &Next);
451 if (!AcpiGbl_DbArgs[i])
459 /* Uppercase the actual command */
461 if (AcpiGbl_DbArgs[0])
463 ACPI_STRUPR (AcpiGbl_DbArgs[0]);
469 Count--; /* Number of args only */
476 /*******************************************************************************
478 * FUNCTION: AcpiDbMatchCommand
480 * PARAMETERS: UserCommand - User command line
482 * RETURN: Index into command array, -1 if not found
484 * DESCRIPTION: Search command array for a command match
486 ******************************************************************************/
495 if (!UserCommand || UserCommand[0] == 0)
500 for (i = CMD_FIRST_VALID; AcpiGbl_DbCommands[i].Name; i++)
502 if (ACPI_STRSTR (AcpiGbl_DbCommands[i].Name, UserCommand) ==
503 AcpiGbl_DbCommands[i].Name)
509 /* Command not recognized */
511 return (CMD_NOT_FOUND);
515 /*******************************************************************************
517 * FUNCTION: AcpiDbCommandDispatch
519 * PARAMETERS: InputBuffer - Command line buffer
520 * WalkState - Current walk
521 * Op - Current (executing) parse op
525 * DESCRIPTION: Command dispatcher. Called from two places:
527 ******************************************************************************/
530 AcpiDbCommandDispatch (
532 ACPI_WALK_STATE *WalkState,
533 ACPI_PARSE_OBJECT *Op)
539 ACPI_STATUS Status = AE_CTRL_TRUE;
542 /* If AcpiTerminate has been called, terminate this thread */
544 if (AcpiGbl_DbTerminateThreads)
546 return (AE_CTRL_TERMINATE);
549 ParamCount = AcpiDbGetLine (InputBuffer);
550 CommandIndex = AcpiDbMatchCommand (AcpiGbl_DbArgs[0]);
553 /* Verify that we have the minimum number of params */
555 if (ParamCount < AcpiGbl_DbCommands[CommandIndex].MinArgs)
557 AcpiOsPrintf ("%d parameters entered, [%s] requires %d parameters\n",
558 ParamCount, AcpiGbl_DbCommands[CommandIndex].Name, AcpiGbl_DbCommands[CommandIndex].MinArgs);
559 return (AE_CTRL_TRUE);
562 /* Decode and dispatch the command */
564 switch (CommandIndex)
573 case CMD_ALLOCATIONS:
575 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
576 AcpiUtDumpAllocations ((UINT32) -1, NULL);
582 AcpiDbDisplayArguments ();
586 AcpiDbSetMethodBreakpoint (AcpiGbl_DbArgs[1], WalkState, Op);
590 AcpiDbSetMethodCallBreakpoint (Op);
595 AcpiDbCloseDebugFile ();
599 AcpiDbExecute (AcpiGbl_DbArgs[1], &AcpiGbl_DbArgs[2], EX_SINGLE_STEP);
603 AcpiDbDecodeAndDisplayObject (AcpiGbl_DbArgs[1], AcpiGbl_DbArgs[2]);
607 Status = AcpiEnable();
608 if (ACPI_FAILURE(Status))
610 AcpiOsPrintf("AcpiEnable failed (Status=%X)\n", Status);
616 AcpiOsPrintf ("Event command not implemented\n");
620 AcpiDbExecute (AcpiGbl_DbArgs[1], &AcpiGbl_DbArgs[2], EX_NO_SINGLE_STEP);
624 AcpiDbFindNameInNamespace (AcpiGbl_DbArgs[1]);
628 AcpiGbl_CmSingleStep = FALSE;
632 AcpiDbGenerateGpe (AcpiGbl_DbArgs[1], AcpiGbl_DbArgs[2]);
636 AcpiDbDisplayGpes ();
641 AcpiDbDisplayHelp (AcpiGbl_DbArgs[1]);
645 AcpiDbDisplayHistory ();
648 case CMD_HISTORY_EXE:
649 CommandLine = AcpiDbGetFromHistory (AcpiGbl_DbArgs[1]);
652 return (AE_CTRL_TRUE);
655 Status = AcpiDbCommandDispatch (CommandLine, WalkState, Op);
656 if (ACPI_SUCCESS (Status))
658 Status = AE_CTRL_TRUE;
662 case CMD_HISTORY_LAST:
663 CommandLine = AcpiDbGetFromHistory (NULL);
666 return (AE_CTRL_TRUE);
669 Status = AcpiDbCommandDispatch (CommandLine, WalkState, Op);
670 if (ACPI_SUCCESS (Status))
672 Status = AE_CTRL_TRUE;
676 case CMD_INFORMATION:
677 AcpiDbDisplayMethodInfo (Op);
681 AcpiDbCheckIntegrity ();
687 AcpiGbl_CmSingleStep = TRUE;
695 AcpiOsPrintf ("Current debug level for file output is: %8.8lX\n", AcpiGbl_DbDebugLevel);
696 AcpiOsPrintf ("Current debug level for console output is: %8.8lX\n", AcpiGbl_DbConsoleDebugLevel);
698 else if (ParamCount == 2)
700 Temp = AcpiGbl_DbConsoleDebugLevel;
701 AcpiGbl_DbConsoleDebugLevel = ACPI_STRTOUL (AcpiGbl_DbArgs[1], NULL, 16);
702 AcpiOsPrintf ("Debug Level for console output was %8.8lX, now %8.8lX\n", Temp, AcpiGbl_DbConsoleDebugLevel);
706 Temp = AcpiGbl_DbDebugLevel;
707 AcpiGbl_DbDebugLevel = ACPI_STRTOUL (AcpiGbl_DbArgs[1], NULL, 16);
708 AcpiOsPrintf ("Debug Level for file output was %8.8lX, now %8.8lX\n", Temp, AcpiGbl_DbDebugLevel);
713 AcpiDbDisassembleAml (AcpiGbl_DbArgs[1], Op);
717 Status = AcpiDbGetTableFromFile (AcpiGbl_DbArgs[1], NULL);
718 if (ACPI_FAILURE (Status))
725 AcpiDbDisplayLocks ();
729 AcpiDbDisplayLocals ();
733 AcpiDbDisplayObjects ("METHOD", AcpiGbl_DbArgs[1]);
737 AcpiDbDumpNamespace (AcpiGbl_DbArgs[1], AcpiGbl_DbArgs[2]);
741 Temp = ACPI_STRTOUL (AcpiGbl_DbArgs[2], NULL, 0);
742 AcpiDbSendNotify (AcpiGbl_DbArgs[1], Temp);
746 ACPI_STRUPR (AcpiGbl_DbArgs[1]);
747 AcpiDbDisplayObjects (AcpiGbl_DbArgs[1], AcpiGbl_DbArgs[2]);
751 AcpiDbOpenDebugFile (AcpiGbl_DbArgs[1]);
755 AcpiDbDumpNamespaceByOwner (AcpiGbl_DbArgs[1], AcpiGbl_DbArgs[2]);
759 AcpiDbSetScope (AcpiGbl_DbArgs[1]);
763 AcpiDbFindReferences (AcpiGbl_DbArgs[1]);
767 AcpiDbDisplayResources (AcpiGbl_DbArgs[1]);
771 AcpiDbDisplayResults ();
775 AcpiDbSetMethodData (AcpiGbl_DbArgs[1], AcpiGbl_DbArgs[2], AcpiGbl_DbArgs[3]);
779 AcpiDbDisplayStatistics (AcpiGbl_DbArgs[1]);
783 return (AE_NOT_IMPLEMENTED);
786 AcpiDbDisplayTableInfo (AcpiGbl_DbArgs[1]);
790 AcpiDbSetOutputDestination (ACPI_DB_REDIRECTABLE_OUTPUT);
791 AcpiUtSubsystemShutdown ();
793 /* TBD: [Restructure] Need some way to re-initialize without re-creating the semaphores! */
795 /* AcpiInitialize (NULL); */
799 AcpiDbCreateExecutionThreads (AcpiGbl_DbArgs[1], AcpiGbl_DbArgs[2], AcpiGbl_DbArgs[3]);
803 AcpiDbDisplayCallingTree ();
807 AcpiDbDisplayObjectType (AcpiGbl_DbArgs[1]);
811 AcpiDbUnloadAcpiTable (AcpiGbl_DbArgs[1], AcpiGbl_DbArgs[2]);
818 AcpiOsPrintf ("Method execution terminated\n");
819 return (AE_CTRL_TERMINATE);
822 if (!AcpiGbl_DbOutputToFile)
824 AcpiDbgLevel = ACPI_DEBUG_DEFAULT;
829 /* AcpiUtSubsystemShutdown (); */
830 AcpiDbCloseDebugFile ();
832 AcpiGbl_DbTerminateThreads = TRUE;
834 return (AE_CTRL_TERMINATE);
838 AcpiOsPrintf ("Unknown Command\n");
839 return (AE_CTRL_TRUE);
843 /* Add all commands that come here to the history buffer */
845 AcpiDbAddToHistory (InputBuffer);
850 /*******************************************************************************
852 * FUNCTION: AcpiDbExecuteThread
854 * PARAMETERS: Context - Not used
858 * DESCRIPTION: Debugger execute thread. Waits for a command line, then
859 * simply dispatches it.
861 ******************************************************************************/
863 void ACPI_SYSTEM_XFACE
864 AcpiDbExecuteThread (
867 ACPI_STATUS Status = AE_OK;
871 while (Status != AE_CTRL_TERMINATE)
873 AcpiGbl_MethodExecuting = FALSE;
874 AcpiGbl_StepToNextCall = FALSE;
876 MStatus = AcpiUtAcquireMutex (ACPI_MTX_DEBUG_CMD_READY);
877 if (ACPI_FAILURE (MStatus))
882 Status = AcpiDbCommandDispatch (AcpiGbl_DbLineBuf, NULL, NULL);
884 MStatus = AcpiUtReleaseMutex (ACPI_MTX_DEBUG_CMD_COMPLETE);
885 if (ACPI_FAILURE (MStatus))
893 /*******************************************************************************
895 * FUNCTION: AcpiDbSingleThread
901 * DESCRIPTION: Debugger execute thread. Waits for a command line, then
902 * simply dispatches it.
904 ******************************************************************************/
911 AcpiGbl_MethodExecuting = FALSE;
912 AcpiGbl_StepToNextCall = FALSE;
914 (void) AcpiDbCommandDispatch (AcpiGbl_DbLineBuf, NULL, NULL);
918 /*******************************************************************************
920 * FUNCTION: AcpiDbUserCommands
922 * PARAMETERS: Prompt - User prompt (depends on mode)
923 * Op - Current executing parse op
927 * DESCRIPTION: Command line execution for the AML debugger. Commands are
928 * matched and dispatched here.
930 ******************************************************************************/
935 ACPI_PARSE_OBJECT *Op)
937 ACPI_STATUS Status = AE_OK;
940 /* TBD: [Restructure] Need a separate command line buffer for step mode */
942 while (!AcpiGbl_DbTerminateThreads)
944 /* Force output to console until a command is entered */
946 AcpiDbSetOutputDestination (ACPI_DB_CONSOLE_OUTPUT);
948 /* Different prompt if method is executing */
950 if (!AcpiGbl_MethodExecuting)
952 AcpiOsPrintf ("%1c ", ACPI_DEBUGGER_COMMAND_PROMPT);
956 AcpiOsPrintf ("%1c ", ACPI_DEBUGGER_EXECUTE_PROMPT);
959 /* Get the user input line */
961 (void) AcpiOsGetLine (AcpiGbl_DbLineBuf);
963 /* Check for single or multithreaded debug */
965 if (AcpiGbl_DebuggerConfiguration & DEBUGGER_MULTI_THREADED)
968 * Signal the debug thread that we have a command to execute,
969 * and wait for the command to complete.
971 Status = AcpiUtReleaseMutex (ACPI_MTX_DEBUG_CMD_READY);
972 if (ACPI_FAILURE (Status))
977 Status = AcpiUtAcquireMutex (ACPI_MTX_DEBUG_CMD_COMPLETE);
978 if (ACPI_FAILURE (Status))
985 /* Just call to the command line interpreter */
987 AcpiDbSingleThread ();
992 * Only this thread (the original thread) should actually terminate the subsystem,
993 * because all the semaphores are deleted during termination
995 Status = AcpiTerminate ();
1000 #endif /* ACPI_DEBUGGER */