1 /******************************************************************************
3 * Module Name: aemain - Main routine for the AcpiExec utility
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2021, 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 "aecommon.h"
154 #define _COMPONENT ACPI_TOOLS
155 ACPI_MODULE_NAME ("aemain")
159 * Main routine for the ACPI user-space execution utility.
161 * Portability note: The utility depends upon the host for command-line
162 * wildcard support - it is not implemented locally. For example:
164 * Linux/Unix systems: Shell expands wildcards automatically.
166 * Windows: The setargv.obj module must be linked in to automatically
170 /* Local prototypes */
178 #define AE_BUFFER_SIZE 1024
179 #define ASL_MAX_FILES 256
181 /* Execution modes */
183 #define AE_MODE_COMMAND_LOOP 0 /* Normal command execution loop */
184 #define AE_MODE_BATCH_MULTIPLE 1 /* -b option to execute a command line */
185 #define AE_MODE_BATCH_SINGLE 2 /* -m option to execute a single control method */
190 BOOLEAN AcpiGbl_UseLocalFaultHandler = TRUE;
191 BOOLEAN AcpiGbl_VerboseHandlers = FALSE;
192 UINT8 AcpiGbl_RegionFillValue = 0;
193 BOOLEAN AcpiGbl_IgnoreErrors = FALSE;
194 BOOLEAN AcpiGbl_AbortLoopOnTimeout = FALSE;
195 UINT8 AcpiGbl_UseHwReducedFadt = FALSE;
196 BOOLEAN AcpiGbl_DoInterfaceTests = FALSE;
197 BOOLEAN AcpiGbl_LoadTestTables = FALSE;
198 BOOLEAN AcpiGbl_AeLoadOnly = FALSE;
199 static UINT8 AcpiGbl_ExecutionMode = AE_MODE_COMMAND_LOOP;
200 static char BatchBuffer[AE_BUFFER_SIZE]; /* Batch command buffer */
201 INIT_FILE_ENTRY *AcpiGbl_InitEntries = NULL;
202 UINT32 AcpiGbl_InitFileLineCount = 0;
204 #define ACPIEXEC_NAME "AML Execution/Debug Utility"
205 #define AE_SUPPORTED_OPTIONS "?b:d:e:f^ghlm^rt^v^:x:"
208 /* Stubs for the disassembler */
212 ACPI_PARSE_OBJECT *Op,
213 AML_RESOURCE *Resource,
222 ACPI_PARSE_OBJECT *Op,
223 AML_RESOURCE *Resource,
229 /******************************************************************************
237 * DESCRIPTION: Print a usage message
239 *****************************************************************************/
246 ACPI_USAGE_HEADER ("acpiexec [options] AMLfile1 AMLfile2 ...");
248 ACPI_OPTION ("-b \"CommandLine\"", "Batch mode command line execution (cmd1;cmd2;...)");
249 ACPI_OPTION ("-h -?", "Display this help message");
250 ACPI_OPTION ("-m [Method]", "Batch mode method execution. Default=MAIN");
253 ACPI_OPTION ("-da", "Disable method abort on error");
254 ACPI_OPTION ("-df", "Disable Local fault handler");
255 ACPI_OPTION ("-di", "Disable execution of STA/INI methods during init");
256 ACPI_OPTION ("-do", "Disable Operation Region address simulation");
257 ACPI_OPTION ("-dr", "Disable repair of method return values");
258 ACPI_OPTION ("-ds", "Disable method auto-serialization");
259 ACPI_OPTION ("-dt", "Disable allocation tracking (performance)");
262 ACPI_OPTION ("-ed", "Enable timer output for Debug Object");
263 ACPI_OPTION ("-ef", "Enable display of final memory statistics");
264 ACPI_OPTION ("-ei", "Enable additional tests for ACPICA interfaces");
265 ACPI_OPTION ("-el", "Enable loading of additional test tables");
266 ACPI_OPTION ("-eo", "Enable object evaluation log");
267 ACPI_OPTION ("-es", "Enable Interpreter Slack Mode");
268 ACPI_OPTION ("-et", "Enable debug semaphore timeout");
271 ACPI_OPTION ("-fi <File>", "Specify namespace initialization file");
272 ACPI_OPTION ("-fv <Value>", "Operation Region initialization fill value");
275 ACPI_OPTION ("-l", "Load tables and namespace only");
276 ACPI_OPTION ("-r", "Use hardware-reduced FADT V5");
277 ACPI_OPTION ("-te", "Exit loop on timeout instead of aborting method");
278 ACPI_OPTION ("-to <Seconds>", "Set timeout period for AML while loops");
281 ACPI_OPTION ("-v", "Display version information");
282 ACPI_OPTION ("-va", "Display verbose dump of any memory leaks");
283 ACPI_OPTION ("-vd", "Display build date and time");
284 ACPI_OPTION ("-vh", "Verbose exception handler output");
285 ACPI_OPTION ("-vi", "Verbose initialization output");
286 ACPI_OPTION ("-vr", "Verbose region handler output");
287 ACPI_OPTION ("-x <DebugLevel>", "Debug output level");
289 printf ("\n From within the interactive mode, use '?' or \"help\" to see\n"
290 " a list of available AML Debugger commands\n");
294 /******************************************************************************
296 * FUNCTION: AeDoOptions
298 * PARAMETERS: argc/argv - Standard argc/argv
302 * DESCRIPTION: Command line option processing
304 *****************************************************************************/
315 while ((j = AcpiGetopt (argc, argv, AE_SUPPORTED_OPTIONS)) != ACPI_OPT_END) switch (j)
319 if (strlen (AcpiGbl_Optarg) > (AE_BUFFER_SIZE -1))
321 printf ("**** The length of command line (%u) exceeded maximum (%d)\n",
322 (UINT32) strlen (AcpiGbl_Optarg), (AE_BUFFER_SIZE -1));
325 AcpiGbl_ExecutionMode = AE_MODE_BATCH_MULTIPLE;
326 strcpy (BatchBuffer, AcpiGbl_Optarg);
331 switch (AcpiGbl_Optarg[0])
335 AcpiGbl_IgnoreErrors = TRUE;
340 AcpiGbl_UseLocalFaultHandler = FALSE;
345 AcpiGbl_DbOpt_NoIniMethods = TRUE;
350 AcpiGbl_DbOpt_NoRegionSupport = TRUE;
355 AcpiGbl_DisableAutoRepair = TRUE;
360 AcpiGbl_AutoSerializeMethods = FALSE;
365 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
366 AcpiGbl_DisableMemTracking = TRUE;
372 printf ("Unknown option: -d%s\n", AcpiGbl_Optarg);
379 switch (AcpiGbl_Optarg[0])
383 AcpiGbl_DisplayDebugTimer = TRUE;
388 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
389 AcpiGbl_DisplayFinalMemStats = TRUE;
395 AcpiGbl_DoInterfaceTests = TRUE;
400 AcpiGbl_LoadTestTables = TRUE;
405 AcpiDbgLevel |= ACPI_LV_EVALUATION;
406 AcpiGbl_DbConsoleDebugLevel |= ACPI_LV_EVALUATION;
411 AcpiGbl_EnableInterpreterSlack = TRUE;
412 printf ("Enabling AML Interpreter slack mode\n");
417 AcpiGbl_DebugTimeout = TRUE;
422 printf ("Unknown option: -e%s\n", AcpiGbl_Optarg);
429 switch (AcpiGbl_Optarg[0])
431 case 'v': /* -fv: region fill value */
433 if (AcpiGetoptArgument (argc, argv))
438 AcpiGbl_RegionFillValue = (UINT8) strtoul (AcpiGbl_Optarg, NULL, 0);
441 case 'i': /* -fi: specify initialization file */
443 if (AcpiGetoptArgument (argc, argv))
448 if (AeOpenInitializationFile (AcpiGbl_Optarg))
456 printf ("Unknown option: -f%s\n", AcpiGbl_Optarg);
463 AcpiGbl_DbFilename = NULL;
474 AcpiGbl_AeLoadOnly = TRUE;
479 AcpiGbl_ExecutionMode = AE_MODE_BATCH_SINGLE;
480 switch (AcpiGbl_Optarg[0])
484 strcpy (BatchBuffer, "MAIN");
489 strcpy (BatchBuffer, AcpiGbl_Optarg);
496 AcpiGbl_UseHwReducedFadt = TRUE;
497 printf ("Using ACPI 5.0 Hardware Reduced Mode via version 5 FADT\n");
502 switch (AcpiGbl_Optarg[0])
504 case 'o': /* -to: Set loop timeout in seconds */
506 if (AcpiGetoptArgument (argc, argv))
511 Temp = strtoul (AcpiGbl_Optarg, NULL, 0);
512 if (!Temp || (Temp > ACPI_UINT16_MAX))
514 printf ("%s: Invalid loop timeout value\n",
519 AcpiGbl_MaxLoopIterations = (UINT16) Temp;
520 printf ("Automatic loop timeout after %u seconds\n",
521 AcpiGbl_MaxLoopIterations);
526 AcpiGbl_AbortLoopOnTimeout = TRUE;
531 printf ("Unknown option: -t%s\n", AcpiGbl_Optarg);
538 switch (AcpiGbl_Optarg[0])
540 case '^': /* -v: (Version): signon already emitted, just exit */
546 AcpiGbl_VerboseLeakDump = TRUE;
551 printf (ACPI_COMMON_BUILD_TIME);
556 AcpiGbl_VerboseHandlers = TRUE;
561 AcpiDbgLevel |= ACPI_LV_INIT_NAMES;
566 AcpiGbl_DisplayRegionAccess = TRUE;
571 printf ("Unknown option: -v%s\n", AcpiGbl_Optarg);
578 AcpiDbgLevel = strtoul (AcpiGbl_Optarg, NULL, 16);
579 AcpiGbl_DbConsoleDebugLevel = AcpiDbgLevel;
580 printf ("Debug Level: 0x%8.8X\n", AcpiDbgLevel);
593 /******************************************************************************
597 * PARAMETERS: argc, argv
601 * DESCRIPTION: Main routine for AcpiExec utility
603 *****************************************************************************/
605 int ACPI_SYSTEM_XFACE
610 ACPI_NEW_TABLE_DESC *ListHead = NULL;
616 ACPI_DEBUG_INITIALIZE (); /* For debug version only */
618 signal (SIGINT, AeSignalHandler);
620 /* Init debug globals */
622 AcpiDbgLevel = ACPI_NORMAL_DEFAULT;
623 AcpiDbgLayer = 0xFFFFFFFF;
626 * Initialize ACPICA and start debugger thread.
628 * NOTE: After ACPICA initialization, AcpiTerminate MUST be called
629 * before this procedure exits -- otherwise, the console may be
630 * left in an incorrect state.
632 Status = AcpiInitializeSubsystem ();
633 ACPI_CHECK_OK (AcpiInitializeSubsystem, Status);
634 if (ACPI_FAILURE (Status))
640 /* Use a shorter timeout value for acpiexec */
642 AcpiGbl_MaxLoopIterations = 10;
644 /* Initialize the AML debugger */
646 Status = AcpiInitializeDebugger ();
647 ACPI_CHECK_OK (AcpiInitializeDebugger, Status);
648 if (ACPI_FAILURE (Status))
654 printf (ACPI_COMMON_SIGNON (ACPIEXEC_NAME));
661 /* Get the command line options */
663 ExitCode = AeDoOptions (argc, argv);
674 if (AcpiGbl_UseLocalFaultHandler)
676 signal (SIGSEGV, AeSignalHandler);
679 /* The remaining arguments are filenames for ACPI tables */
681 if (!argv[AcpiGbl_Optind])
686 AcpiGbl_CstyleDisassembly = FALSE; /* Not supported for AcpiExec */
688 /* Get each of the ACPI table files on the command line */
690 while (argv[AcpiGbl_Optind])
692 /* Get all ACPI AML tables in this file */
694 Status = AcGetAllTablesFromFile (argv[AcpiGbl_Optind],
695 ACPI_GET_ALL_TABLES, &ListHead);
696 if (ACPI_FAILURE (Status))
707 /* Build a local RSDT with all tables and let ACPICA process the RSDT */
709 Status = AeBuildLocalTables (ListHead);
710 if (ACPI_FAILURE (Status))
716 /* Install all of the ACPI tables */
718 Status = AeInstallTables ();
719 if (ACPI_FAILURE (Status))
721 printf ("**** Could not install ACPI tables, %s\n",
722 AcpiFormatException (Status));
727 * Install most of the handlers (Regions, Notify, Table, etc.)
728 * Override the default region handlers, especially SystemMemory,
729 * which is simulated in this utility.
731 Status = AeInstallEarlyHandlers ();
732 if (ACPI_FAILURE (Status))
737 /* Read the entire namespace initialization file if requested */
739 Status = AeProcessInitFile();
740 if (ACPI_FAILURE (Status))
746 Status = AeLoadTables ();
747 if (ACPI_FAILURE (Status))
749 printf ("**** Could not load ACPI tables, %s\n",
750 AcpiFormatException (Status));
755 * Exit namespace initialization for the "load namespace only" option.
756 * No control methods will be executed. However, still enter the
759 if (AcpiGbl_AeLoadOnly)
764 /* Setup initialization flags for ACPICA */
766 InitFlags = (ACPI_NO_HANDLER_INIT | ACPI_NO_ACPI_ENABLE);
767 if (AcpiGbl_DbOpt_NoIniMethods)
769 InitFlags |= (ACPI_NO_DEVICE_INIT | ACPI_NO_OBJECT_INIT);
773 * Main initialization for ACPICA subsystem
774 * TBD: Need a way to call this after the ACPI table "LOAD" command?
776 * NOTE: This initialization does not match the _Lxx and _Exx methods
777 * to individual GPEs, as there are no real GPEs when the hardware
778 * is simulated - because there is no namespace until AeLoadTables is
779 * executed. This may have to change if AcpiExec is ever run natively
780 * on actual hardware (such as under UEFI).
782 Status = AcpiEnableSubsystem (InitFlags);
783 if (ACPI_FAILURE (Status))
785 printf ("**** Could not EnableSubsystem, %s\n",
786 AcpiFormatException (Status));
791 * Install handlers for "device driver" space IDs (EC,SMBus, etc.)
792 * and fixed event handlers
794 AeInstallLateHandlers ();
796 /* Finish the ACPICA initialization */
798 Status = AcpiInitializeObjects (InitFlags);
799 if (ACPI_FAILURE (Status))
801 printf ("**** Could not InitializeObjects, %s\n",
802 AcpiFormatException (Status));
806 AeDisplayUnusedInitFileItems ();
807 AeMiscellaneousTests ();
812 /* Exit if error above and we are in one of the batch modes */
814 if (ACPI_FAILURE (Status) && (AcpiGbl_ExecutionMode > 0))
819 /* Run a batch command or enter the command loop */
821 switch (AcpiGbl_ExecutionMode)
824 case AE_MODE_COMMAND_LOOP:
826 AcpiRunDebugger (NULL);
829 case AE_MODE_BATCH_MULTIPLE:
831 AcpiRunDebugger (BatchBuffer);
834 case AE_MODE_BATCH_SINGLE:
836 AcpiDbExecute (BatchBuffer, NULL, NULL, EX_NO_SINGLE_STEP);
840 /* Shut down the debugger and ACPICA */
842 AcpiTerminateDebugger ();
844 /* re-enable debug output for AcpiTerminate output */
846 AcpiGbl_DbOutputFlags = ACPI_DB_CONSOLE_OUTPUT;
854 AeDeleteInitFileList ();
856 (void) AcpiTerminate ();
857 AcDeleteTableList (ListHead);