1 /******************************************************************************
3 * Module Name: adisasm - Application-level disassembler routines
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 "aslcompiler.h"
154 #include "acdisasm.h"
155 #include "acdispat.h"
156 #include "acnamesp.h"
157 #include "acparser.h"
159 #include "acconvert.h"
162 #define _COMPONENT ACPI_TOOLS
163 ACPI_MODULE_NAME ("adisasm")
165 /* Local prototypes */
168 AdDoExternalFileList (
172 AdDisassembleOneTable (
173 ACPI_TABLE_HEADER *Table,
176 char *DisasmFilename);
180 ACPI_TABLE_HEADER *Table,
182 ACPI_OWNER_ID OwnerId);
185 ACPI_TABLE_DESC LocalTables[1];
186 ACPI_PARSE_OBJECT *AcpiGbl_ParseOpRoot;
189 /* Stubs for everything except ASL compiler */
191 #ifndef ACPI_ASL_COMPILER
194 ACPI_PARSE_OBJECT *Op,
195 ACPI_WALK_STATE *WalkState)
203 ACPI_WALK_STATE *WalkState)
210 /*******************************************************************************
212 * FUNCTION: AdInitialize
218 * DESCRIPTION: ACPICA and local initialization
220 ******************************************************************************/
229 /* ACPICA subsystem initialization */
231 Status = AcpiOsInitialize ();
232 if (ACPI_FAILURE (Status))
234 fprintf (stderr, "Could not initialize ACPICA subsystem: %s\n",
235 AcpiFormatException (Status));
240 Status = AcpiUtInitGlobals ();
241 if (ACPI_FAILURE (Status))
243 fprintf (stderr, "Could not initialize ACPICA globals: %s\n",
244 AcpiFormatException (Status));
249 Status = AcpiUtMutexInitialize ();
250 if (ACPI_FAILURE (Status))
252 fprintf (stderr, "Could not initialize ACPICA mutex objects: %s\n",
253 AcpiFormatException (Status));
258 Status = AcpiNsRootInitialize ();
259 if (ACPI_FAILURE (Status))
261 fprintf (stderr, "Could not initialize ACPICA namespace: %s\n",
262 AcpiFormatException (Status));
267 /* Setup the Table Manager (cheat - there is no RSDT) */
269 AcpiGbl_RootTableList.MaxTableCount = 1;
270 AcpiGbl_RootTableList.CurrentTableCount = 0;
271 AcpiGbl_RootTableList.Tables = LocalTables;
277 /******************************************************************************
279 * FUNCTION: AdAmlDisassemble
281 * PARAMETERS: Filename - AML input filename
282 * OutToFile - TRUE if output should go to a file
283 * Prefix - Path prefix for output
284 * OutFilename - where the filename is returned
288 * DESCRIPTION: Disassembler entry point. Disassemble an entire ACPI table.
290 *****************************************************************************/
300 char *DisasmFilename = NULL;
302 ACPI_TABLE_HEADER *Table = NULL;
303 ACPI_NEW_TABLE_DESC *ListHead = NULL;
307 * Input: AML code from either a file or via GetTables (memory or
312 /* Get the list of all AML tables in the file */
314 Status = AcGetAllTablesFromFile (Filename,
315 ACPI_GET_ALL_TABLES, &ListHead);
316 if (ACPI_FAILURE (Status))
318 AcpiOsPrintf ("Could not get ACPI tables from %s, %s\n",
319 Filename, AcpiFormatException (Status));
323 /* Process any user-specified files for external objects */
325 Status = AdDoExternalFileList (Filename);
326 if (ACPI_FAILURE (Status))
333 Status = AdGetLocalTables ();
334 if (ACPI_FAILURE (Status))
336 AcpiOsPrintf ("Could not get ACPI tables, %s\n",
337 AcpiFormatException (Status));
341 if (!AcpiGbl_DmOpt_Disasm)
346 /* Obtained the local tables, just disassemble the DSDT */
348 Status = AcpiGetTable (ACPI_SIG_DSDT, 0, &Table);
349 if (ACPI_FAILURE (Status))
351 AcpiOsPrintf ("Could not get DSDT, %s\n",
352 AcpiFormatException (Status));
356 AcpiOsPrintf ("\nDisassembly of DSDT\n");
357 Prefix = AdGenerateFilename ("dsdt", Table->OemTableId);
361 * Output: ASL code. Redirect to a file if requested
365 /* Create/Open a disassembly output file */
367 DisasmFilename = FlGenerateFilename (Prefix, FILE_SUFFIX_DISASSEMBLY);
370 fprintf (stderr, "Could not generate output filename\n");
375 File = fopen (DisasmFilename, "w+");
378 fprintf (stderr, "Could not open output file %s\n",
385 *OutFilename = DisasmFilename;
387 /* Disassemble all AML tables within the file */
391 Status = AdDisassembleOneTable (ListHead->Table,
392 File, Filename, DisasmFilename);
393 if (ACPI_FAILURE (Status))
398 ListHead = ListHead->Next;
404 !AcpiGbl_ForceAmlDisassembly &&
405 !AcpiUtIsAmlTable (Table))
410 AcDeleteTableList (ListHead);
415 AcpiOsRedirectOutput (stdout);
418 AcpiPsDeleteParseTree (AcpiGbl_ParseOpRoot);
419 AcpiGbl_ParseOpRoot = NULL;
424 /******************************************************************************
426 * FUNCTION: AdDisassembleOneTable
428 * PARAMETERS: Table - Raw AML table
429 * File - Pointer for the input file
430 * Filename - AML input filename
431 * DisasmFilename - Output filename
435 * DESCRIPTION: Disassemble a single ACPI table. AML or data table.
437 *****************************************************************************/
440 AdDisassembleOneTable (
441 ACPI_TABLE_HEADER *Table,
444 char *DisasmFilename)
447 ACPI_OWNER_ID OwnerId;
450 #ifdef ACPI_ASL_COMPILER
453 * For ASL-/ASL+ converter: replace the temporary "XXXX"
454 * table signature with the original. This "XXXX" makes
455 * it harder for the AML interpreter to run the badaml
456 * (.xxx) file produced from the converter in case if
457 * it fails to get deleted.
459 if (AcpiGbl_CaptureComments)
461 strncpy (Table->Signature, AcpiGbl_TableSig, ACPI_NAMESEG_SIZE);
465 /* ForceAmlDisassembly means to assume the table contains valid AML */
467 if (!AcpiGbl_ForceAmlDisassembly && !AcpiUtIsAmlTable (Table))
471 AcpiOsRedirectOutput (File);
474 AdDisassemblerHeader (Filename, ACPI_IS_DATA_TABLE);
476 /* This is a "Data Table" (non-AML table) */
478 AcpiOsPrintf (" * ACPI Data Table [%4.4s]\n *\n",
480 AcpiOsPrintf (" * Format: [HexOffset DecimalOffset ByteLength] "
481 "FieldName : FieldValue\n */\n\n");
483 AcpiDmDumpDataTable (Table);
484 fprintf (stderr, "Acpi Data Table [%4.4s] decoded\n",
489 fprintf (stderr, "Formatted output: %s - %u bytes\n",
490 DisasmFilename, CmGetFileSize (File));
496 /* Initialize the converter output file */
498 ASL_CV_INIT_FILETREE(Table, File);
501 * This is an AML table (DSDT or SSDT).
502 * Always parse the tables, only option is what to display
504 Status = AdParseTable (Table, &OwnerId, TRUE, FALSE);
505 if (ACPI_FAILURE (Status))
507 AcpiOsPrintf ("Could not parse ACPI tables, %s\n",
508 AcpiFormatException (Status));
512 /* Redirect output for code generation and debugging output */
516 AcpiOsRedirectOutput (File);
519 /* Debug output, namespace and parse tree */
521 if (AslCompilerdebug && File)
523 AcpiOsPrintf ("/**** Before second load\n");
525 NsSetupNamespaceListing (File);
526 NsDisplayNamespace ();
528 AcpiOsPrintf ("*****/\n");
531 /* Load namespace from names created within control methods */
533 AcpiDmFinishNamespaceLoad (AcpiGbl_ParseOpRoot,
534 AcpiGbl_RootNode, OwnerId);
537 * Cross reference the namespace here, in order to
538 * generate External() statements
540 AcpiDmCrossReferenceNamespace (AcpiGbl_ParseOpRoot,
541 AcpiGbl_RootNode, OwnerId);
543 if (AslCompilerdebug)
545 AcpiDmDumpTree (AcpiGbl_ParseOpRoot);
548 /* Find possible calls to external control methods */
550 AcpiDmFindOrphanMethods (AcpiGbl_ParseOpRoot);
553 * If we found any external control methods, we must reparse
554 * the entire tree with the new information (namely, the
555 * number of arguments per method)
557 if (AcpiDmGetUnresolvedExternalMethodCount ())
559 Status = AdReparseOneTable (Table, File, OwnerId);
560 if (ACPI_FAILURE (Status))
567 * Now that the namespace is finalized, we can perform namespace
570 * 1) Convert fixed-offset references to resource descriptors
571 * to symbolic references (Note: modifies namespace)
573 AcpiDmConvertParseObjects (AcpiGbl_ParseOpRoot, AcpiGbl_RootNode);
575 /* Optional displays */
577 if (AcpiGbl_DmOpt_Disasm)
579 /* This is the real disassembly */
581 AdDisplayTables (Filename, Table);
583 /* Dump hex table if requested (-vt) */
585 AcpiDmDumpDataTable (Table);
587 fprintf (stderr, "Disassembly completed\n");
590 fprintf (stderr, "ASL Output: %s - %u bytes\n",
591 DisasmFilename, CmGetFileSize (File));
594 if (AslGbl_MapfileFlag)
596 fprintf (stderr, "%14s %s - %u bytes\n",
597 AslGbl_FileDescs[ASL_FILE_MAP_OUTPUT].ShortDescription,
598 AslGbl_Files[ASL_FILE_MAP_OUTPUT].Filename,
599 FlGetFileSize (ASL_FILE_MAP_OUTPUT));
607 /******************************************************************************
609 * FUNCTION: AdReparseOneTable
611 * PARAMETERS: Table - Raw AML table
612 * File - Pointer for the input file
613 * OwnerId - ID for this table
617 * DESCRIPTION: Reparse a table that has already been loaded. Used to
618 * integrate information about external control methods.
619 * These methods may have been previously parsed incorrectly.
621 *****************************************************************************/
625 ACPI_TABLE_HEADER *Table,
627 ACPI_OWNER_ID OwnerId)
630 ACPI_COMMENT_ADDR_NODE *AddrListHead;
634 "\nFound %u external control methods, "
635 "reparsing with new information\n",
636 AcpiDmGetUnresolvedExternalMethodCount ());
638 /* Reparse, rebuild namespace */
640 AcpiPsDeleteParseTree (AcpiGbl_ParseOpRoot);
641 AcpiGbl_ParseOpRoot = NULL;
642 AcpiNsDeleteNamespaceSubtree (AcpiGbl_RootNode);
644 AcpiGbl_RootNode = NULL;
645 AcpiGbl_RootNodeStruct.Name.Integer = ACPI_ROOT_NAME;
646 AcpiGbl_RootNodeStruct.DescriptorType = ACPI_DESC_TYPE_NAMED;
647 AcpiGbl_RootNodeStruct.Type = ACPI_TYPE_DEVICE;
648 AcpiGbl_RootNodeStruct.Parent = NULL;
649 AcpiGbl_RootNodeStruct.Child = NULL;
650 AcpiGbl_RootNodeStruct.Peer = NULL;
651 AcpiGbl_RootNodeStruct.Object = NULL;
652 AcpiGbl_RootNodeStruct.Flags = 0;
654 Status = AcpiNsRootInitialize ();
655 if (ACPI_FAILURE (Status))
660 /* New namespace, add the external definitions first */
662 AcpiDmAddExternalListToNamespace ();
664 /* For -ca option: clear the list of comment addresses. */
666 while (AcpiGbl_CommentAddrListHead)
668 AddrListHead= AcpiGbl_CommentAddrListHead;
669 AcpiGbl_CommentAddrListHead = AcpiGbl_CommentAddrListHead->Next;
670 AcpiOsFree(AddrListHead);
673 /* Parse the table again. No need to reload it, however */
675 Status = AdParseTable (Table, NULL, FALSE, FALSE);
676 if (ACPI_FAILURE (Status))
678 AcpiOsPrintf ("Could not parse ACPI tables, %s\n",
679 AcpiFormatException (Status));
683 /* Cross reference the namespace again */
685 AcpiDmFinishNamespaceLoad (AcpiGbl_ParseOpRoot,
686 AcpiGbl_RootNode, OwnerId);
688 AcpiDmCrossReferenceNamespace (AcpiGbl_ParseOpRoot,
689 AcpiGbl_RootNode, OwnerId);
691 /* Debug output - namespace and parse tree */
693 if (AslCompilerdebug)
695 AcpiOsPrintf ("/**** After second load and resource conversion\n");
698 NsSetupNamespaceListing (File);
699 NsDisplayNamespace ();
702 AcpiOsPrintf ("*****/\n");
703 AcpiDmDumpTree (AcpiGbl_ParseOpRoot);
710 /******************************************************************************
712 * FUNCTION: AdDoExternalFileList
714 * PARAMETERS: Filename - Input file for the table
718 * DESCRIPTION: Process all tables found in the -e external files list
720 *****************************************************************************/
723 AdDoExternalFileList (
726 ACPI_EXTERNAL_FILE *ExternalFileList;
727 char *ExternalFilename;
728 ACPI_NEW_TABLE_DESC *ExternalListHead = NULL;
730 ACPI_STATUS GlobalStatus = AE_OK;
731 ACPI_OWNER_ID OwnerId;
735 * External filenames are specified on the command line like this:
736 * Example: iasl -e file1,file2,file3 -d xxx.aml
738 ExternalFileList = AcpiGbl_ExternalFileList;
740 /* Process each external file */
742 while (ExternalFileList)
744 ExternalFilename = ExternalFileList->Path;
745 if (!strcmp (ExternalFilename, Filename))
747 /* Next external file */
749 ExternalFileList = ExternalFileList->Next;
753 AcpiOsPrintf ("External object resolution file %16s\n",
756 Status = AcGetAllTablesFromFile (
757 ExternalFilename, ACPI_GET_ONLY_AML_TABLES, &ExternalListHead);
758 if (ACPI_FAILURE (Status))
760 if (Status == AE_TYPE)
762 ExternalFileList = ExternalFileList->Next;
763 GlobalStatus = AE_TYPE;
767 AcDeleteTableList (ExternalListHead);
771 /* Load external tables for symbol resolution */
773 while (ExternalListHead)
775 Status = AdParseTable (
776 ExternalListHead->Table, &OwnerId, TRUE, TRUE);
777 if (ACPI_FAILURE (Status))
779 AcpiOsPrintf ("Could not parse external ACPI tables, %s\n",
780 AcpiFormatException (Status));
781 AcDeleteTableList (ExternalListHead);
786 * Load namespace from names created within control methods
787 * Set owner id of nodes in external table
789 AcpiDmFinishNamespaceLoad (AcpiGbl_ParseOpRoot,
790 AcpiGbl_RootNode, OwnerId);
791 AcpiPsDeleteParseTree (AcpiGbl_ParseOpRoot);
793 ExternalListHead = ExternalListHead->Next;
796 /* Next external file */
798 ExternalFileList = ExternalFileList->Next;
801 AcDeleteTableList (ExternalListHead);
803 if (ACPI_FAILURE (GlobalStatus))
805 return (GlobalStatus);
808 /* Clear external list generated by Scope in external tables */
810 if (AcpiGbl_ExternalFileList)
812 AcpiDmClearExternalList ();
815 /* Load any externals defined in the optional external ref file */
817 AcpiDmGetExternalsFromFile ();