2 /******************************************************************************
4 * Module Name: aslmain - compiler main and utilities
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2010, 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 *****************************************************************************/
118 #define _DECLARE_GLOBALS
120 #include <contrib/dev/acpica/compiler/aslcompiler.h>
121 #include <contrib/dev/acpica/include/acapps.h>
122 #include <contrib/dev/acpica/include/acdisasm.h>
128 #define _COMPONENT ACPI_COMPILER
129 ACPI_MODULE_NAME ("aslmain")
131 /* Local prototypes */
158 BOOLEAN IsResponseFile);
161 AslMergeOptionTokens (
170 #define ASL_TOKEN_SEPARATORS " \t\n"
171 #define ASL_SUPPORTED_OPTIONS "@:2b:c:d^e:fgh^i^I:l^no:p:r:s:t:T:v:w:x:z"
174 /*******************************************************************************
182 * DESCRIPTION: Display option help message
184 ******************************************************************************/
191 printf ("Global:\n");
192 printf (" -@<file> Specify command file\n");
193 printf (" -I<dir> Specify additional include directory\n");
195 printf ("\nGeneral Output:\n");
196 printf (" -p<prefix> Specify path/filename prefix for all output files\n");
197 printf (" -va Disable all errors and warnings (summary only)\n");
198 printf (" -vi Less verbose errors and warnings for use with IDEs\n");
199 printf (" -vo Enable optimization comments\n");
200 printf (" -vr Disable remarks\n");
201 printf (" -vs Disable signon\n");
202 printf (" -w<1|2|3> Set warning reporting level\n");
204 printf ("\nAML Output Files:\n");
205 printf (" -s<a|c> Create AML in assembler or C source file (*.asm or *.c)\n");
206 printf (" -i<a|c> Create assembler or C include file (*.inc or *.h)\n");
207 printf (" -t<a|c|s> Create AML in assembler, C, or ASL hex table (*.hex)\n");
209 printf ("\nAML Code Generation:\n");
210 printf (" -oa Disable all optimizations (compatibility mode)\n");
211 printf (" -of Disable constant folding\n");
212 printf (" -oi Disable integer optimization to Zero/One/Ones\n");
213 printf (" -on Disable named reference string optimization\n");
214 printf (" -cr Disable Resource Descriptor error checking\n");
215 printf (" -r<Revision> Override table header Revision (1-255)\n");
217 printf ("\nASL Listing Files:\n");
218 printf (" -l Create mixed listing file (ASL source and AML) (*.lst)\n");
219 printf (" -ln Create namespace file (*.nsp)\n");
220 printf (" -ls Create combined source file (expanded includes) (*.src)\n");
222 printf ("\nACPI Data Tables:\n");
223 printf (" -T <Sig> Create table template file for <Sig> (or \"ALL\")\n");
224 printf (" -vt Create verbose templates (full disassembly)\n");
226 printf ("\nAML Disassembler:\n");
227 printf (" -d [file] Disassemble or decode binary ACPI table to file (*.dsl)\n");
228 printf (" -da [f1,f2] Disassemble multiple tables from single namespace\n");
229 printf (" -dc [file] Disassemble AML and immediately compile it\n");
230 printf (" (Obtain DSDT from current system if no input file)\n");
231 printf (" -e [f1,f2] Include ACPI table(s) for external symbol resolution\n");
232 printf (" -2 Emit ACPI 2.0 compatible ASL code\n");
233 printf (" -g Get ACPI tables and write to files (*.dat)\n");
235 printf ("\nHelp:\n");
236 printf (" -h Additional help and compiler debug options\n");
237 printf (" -hc Display operators allowed in constant expressions\n");
238 printf (" -hr Display ACPI reserved method names\n");
239 printf (" -ht Display currently supported ACPI table names\n");
243 /*******************************************************************************
245 * FUNCTION: HelpMessage
251 * DESCRIPTION: Display help message
253 ******************************************************************************/
260 printf ("AML output filename generation:\n");
261 printf (" Output filenames are generated by appending an extension to a common\n");
262 printf (" filename prefix. The filename prefix is obtained via one of the\n");
263 printf (" following methods (in priority order):\n");
264 printf (" 1) The -p option specifies the prefix\n");
265 printf (" 2) The prefix of the AMLFileName in the ASL Definition Block\n");
266 printf (" 3) The prefix of the input filename\n");
271 printf ("\nCompiler/Disassembler Debug Options:\n");
272 printf (" -b<p|t|b> Create compiler debug/trace file (*.txt)\n");
273 printf (" Types: Parse/Tree/Both\n");
274 printf (" -f Ignore errors, force creation of AML output file(s)\n");
275 printf (" -n Parse only, no output generation\n");
276 printf (" -ot Display compile times\n");
277 printf (" -x<level> Set debug level for trace output\n");
278 printf (" -z Do not insert new compiler ID for DataTables\n");
282 /*******************************************************************************
290 * DESCRIPTION: Display usage and option message
292 ******************************************************************************/
299 printf ("%s\n", ASL_COMPLIANCE);
300 printf ("Usage: %s [Options] [Files]\n\n", ASL_INVOCATION_NAME);
305 /*******************************************************************************
307 * FUNCTION: AslInitialize
313 * DESCRIPTION: Initialize compiler globals
315 ******************************************************************************/
325 _CrtSetDbgFlag (_CRTDBG_CHECK_ALWAYS_DF | _CrtSetDbgFlag(0));
330 for (i = 0; i < ASL_NUM_FILES; i++)
332 Gbl_Files[i].Handle = NULL;
333 Gbl_Files[i].Filename = NULL;
336 Gbl_Files[ASL_FILE_STDOUT].Handle = stdout;
337 Gbl_Files[ASL_FILE_STDOUT].Filename = "STDOUT";
339 Gbl_Files[ASL_FILE_STDERR].Handle = stderr;
340 Gbl_Files[ASL_FILE_STDERR].Filename = "STDERR";
344 /*******************************************************************************
346 * FUNCTION: AslMergeOptionTokens
348 * PARAMETERS: InBuffer - Input containing an option string
349 * OutBuffer - Merged output buffer
353 * DESCRIPTION: Remove all whitespace from an option string.
355 ******************************************************************************/
358 AslMergeOptionTokens (
367 Token = strtok (InBuffer, ASL_TOKEN_SEPARATORS);
370 strcat (OutBuffer, Token);
371 Token = strtok (NULL, ASL_TOKEN_SEPARATORS);
376 /*******************************************************************************
378 * FUNCTION: AslDoResponseFile
380 * PARAMETERS: Filename - Name of the response file
384 * DESCRIPTION: Open a response file and process all options within.
386 ******************************************************************************/
392 char *argv = StringBuffer2;
399 ResponseFile = fopen (Filename, "r");
402 printf ("Could not open command file %s, %s\n",
403 Filename, strerror (errno));
407 /* Must save the current GetOpt globals */
409 Opterr = AcpiGbl_Opterr;
410 Optind = AcpiGbl_Optind;
413 * Process all lines in the response file. There must be one complete
416 while (fgets (StringBuffer, ASL_MSG_BUFFER_SIZE, ResponseFile))
418 /* Compress all tokens, allowing us to use a single argv entry */
420 AslMergeOptionTokens (StringBuffer, StringBuffer2);
422 /* Process the option */
427 OptStatus = AslDoOptions (1, &argv, TRUE);
430 printf ("Invalid option in command file %s: %s\n",
431 Filename, StringBuffer);
436 /* Restore the GetOpt globals */
438 AcpiGbl_Opterr = Opterr;
439 AcpiGbl_Optind = Optind;
441 fclose (ResponseFile);
446 /*******************************************************************************
448 * FUNCTION: AslDoOptions
450 * PARAMETERS: argc/argv - Standard argc/argv
451 * IsResponseFile - TRUE if executing a response file.
455 * DESCRIPTION: Command line option processing
457 ******************************************************************************/
463 BOOLEAN IsResponseFile)
469 /* Get the command line options */
471 while ((j = AcpiGetopt (argc, argv, ASL_SUPPORTED_OPTIONS)) != EOF) switch (j)
473 case '@': /* Begin a response file */
477 printf ("Nested command files are not supported\n");
481 if (AslDoResponseFile (AcpiGbl_Optarg))
496 switch (AcpiGbl_Optarg[0])
499 AslCompilerdebug = 1; /* same as yydebug */
503 AslCompilerdebug = 1; /* same as yydebug */
510 printf ("Unknown option: -b%s\n", AcpiGbl_Optarg);
514 /* Produce debug output file */
516 Gbl_DebugFlag = TRUE;
521 switch (AcpiGbl_Optarg[0])
524 Gbl_NoResourceChecking = TRUE;
528 printf ("Unknown option: -c%s\n", AcpiGbl_Optarg);
535 switch (AcpiGbl_Optarg[0])
538 Gbl_DoCompile = FALSE;
542 Gbl_DoCompile = FALSE;
543 Gbl_DisassembleAll = TRUE;
550 printf ("Unknown option: -d%s\n", AcpiGbl_Optarg);
554 Gbl_DisasmFlag = TRUE;
559 Status = AcpiDmAddToExternalFileList (AcpiGbl_Optarg);
560 if (ACPI_FAILURE (Status))
562 printf ("Could not add %s to external list\n", AcpiGbl_Optarg);
570 /* Ignore errors and force creation of aml file */
572 Gbl_IgnoreErrors = TRUE;
578 /* Get all ACPI tables */
580 Gbl_GetAllTables = TRUE;
581 Gbl_DoCompile = FALSE;
587 switch (AcpiGbl_Optarg[0])
594 UtDisplayConstantOpcodes ();
600 ApDisplayReservedNames ();
604 UtDisplaySupportedTables ();
608 printf ("Unknown option: -h%s\n", AcpiGbl_Optarg);
613 case 'I': /* Add an include file search directory */
615 FlAddIncludeDirectory (AcpiGbl_Optarg);
621 switch (AcpiGbl_Optarg[0])
625 /* Produce assembly code include file */
627 Gbl_AsmIncludeOutputFlag = TRUE;
632 /* Produce C include file */
634 Gbl_C_IncludeOutputFlag = TRUE;
638 printf ("Unknown option: -s%s\n", AcpiGbl_Optarg);
646 switch (AcpiGbl_Optarg[0])
649 /* Produce listing file (Mixed source/aml) */
651 Gbl_ListingFlag = TRUE;
655 /* Produce namespace file */
657 Gbl_NsOutputFlag = TRUE;
661 /* Produce combined source file */
663 Gbl_SourceOutputFlag = TRUE;
667 printf ("Unknown option: -l%s\n", AcpiGbl_Optarg);
675 switch (AcpiGbl_Optarg[0])
679 /* Disable all optimizations */
681 Gbl_FoldConstants = FALSE;
682 Gbl_IntegerOptimizationFlag = FALSE;
683 Gbl_ReferenceOptimizationFlag = FALSE;
688 /* Disable folding on "normal" expressions */
690 Gbl_FoldConstants = FALSE;
695 /* Disable integer optimization to constants */
697 Gbl_IntegerOptimizationFlag = FALSE;
702 /* Disable named reference optimization */
704 Gbl_ReferenceOptimizationFlag = FALSE;
709 /* Display compile time(s) */
711 Gbl_CompileTimesFlag = TRUE;
715 printf ("Unknown option: -c%s\n", AcpiGbl_Optarg);
725 Gbl_ParseOnlyFlag = TRUE;
731 /* Override default AML output filename */
733 Gbl_OutputFilenamePrefix = AcpiGbl_Optarg;
734 Gbl_UseDefaultAmlFilename = FALSE;
739 Gbl_RevisionOverride = (UINT8) strtoul (AcpiGbl_Optarg, NULL, 0);
745 switch (AcpiGbl_Optarg[0])
749 /* Produce assembly code output file */
751 Gbl_AsmOutputFlag = TRUE;
756 /* Produce C hex output file */
758 Gbl_C_OutputFlag = TRUE;
762 printf ("Unknown option: -s%s\n", AcpiGbl_Optarg);
770 /* Produce hex table output file */
772 switch (AcpiGbl_Optarg[0])
775 Gbl_HexOutputFlag = HEX_OUTPUT_ASM;
779 Gbl_HexOutputFlag = HEX_OUTPUT_C;
783 Gbl_HexOutputFlag = HEX_OUTPUT_ASL;
787 printf ("Unknown option: -t%s\n", AcpiGbl_Optarg);
794 Gbl_DoTemplates = TRUE;
795 Gbl_TemplateSignature = AcpiGbl_Optarg;
801 switch (AcpiGbl_Optarg[0])
804 /* Disable All error/warning messages */
810 /* Less verbose error messages */
812 Gbl_VerboseErrors = FALSE;
816 Gbl_DisplayOptimizations = TRUE;
820 Gbl_DisplayRemarks = FALSE;
824 Gbl_DoSignon = FALSE;
828 Gbl_VerboseTemplates = TRUE;
832 printf ("Unknown option: -v%s\n", AcpiGbl_Optarg);
838 case 'w': /* Set warning levels */
840 switch (AcpiGbl_Optarg[0])
843 Gbl_WarningLevel = ASL_WARNING;
847 Gbl_WarningLevel = ASL_WARNING2;
851 Gbl_WarningLevel = ASL_WARNING3;
855 printf ("Unknown option: -w%s\n", AcpiGbl_Optarg);
863 AcpiDbgLevel = strtoul (AcpiGbl_Optarg, NULL, 16);
869 Gbl_UseOriginalCompilerId = TRUE;
882 /*******************************************************************************
884 * FUNCTION: AslCommandLine
886 * PARAMETERS: argc/argv
888 * RETURN: Last argv index
890 * DESCRIPTION: Command line processing
892 ******************************************************************************/
899 int BadCommandLine = 0;
903 /* Minimum command line contains at least the command and an input file */
907 printf (ACPI_COMMON_SIGNON (ASL_COMPILER_NAME));
912 /* Process all command line options */
914 BadCommandLine = AslDoOptions (argc, argv, FALSE);
918 Status = DtCreateTemplates (Gbl_TemplateSignature);
919 if (ACPI_FAILURE (Status))
926 /* Next parameter must be the input filename */
928 if (!argv[AcpiGbl_Optind] &&
932 printf ("Missing input filename\n");
933 BadCommandLine = TRUE;
938 printf (ACPI_COMMON_SIGNON (ASL_COMPILER_NAME));
941 /* Abort if anything went wrong on the command line */
950 return (AcpiGbl_Optind);
954 /*******************************************************************************
958 * PARAMETERS: Standard argc/argv
960 * RETURN: Program termination code
962 * DESCRIPTION: C main routine for the Asl Compiler. Handle command line
963 * options and begin the compile for each file on the command line
965 ******************************************************************************/
967 int ACPI_SYSTEM_XFACE
977 AcpiGbl_ExternalFileList = NULL;
980 _CrtSetDbgFlag (_CRTDBG_CHECK_ALWAYS_DF | _CRTDBG_LEAK_CHECK_DF |
981 _CrtSetDbgFlag(_CRTDBG_REPORT_FLAG));
984 /* Init and command line */
987 Index1 = Index2 = AslCommandLine (argc, argv);
989 /* Options that have no additional parameters or pathnames */
991 if (Gbl_GetAllTables)
993 Status = AslDoOneFile (NULL);
994 if (ACPI_FAILURE (Status))
1001 if (Gbl_DisassembleAll)
1003 while (argv[Index1])
1005 Status = AslDoOnePathname (argv[Index1], AcpiDmAddToExternalFileList);
1006 if (ACPI_FAILURE (Status))
1015 /* Process each pathname/filename in the list, with possible wildcards */
1017 while (argv[Index2])
1019 Status = AslDoOnePathname (argv[Index2], AslDoOneFile);
1020 if (ACPI_FAILURE (Status))
1028 if (AcpiGbl_ExternalFileList)
1030 AcpiDmClearExternalFileList();