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>
127 #define _COMPONENT ACPI_COMPILER
128 ACPI_MODULE_NAME ("aslmain")
130 /* Local prototypes */
157 BOOLEAN IsResponseFile);
160 AslMergeOptionTokens (
169 #define ASL_TOKEN_SEPARATORS " \t\n"
170 #define ASL_SUPPORTED_OPTIONS "@:2b:cd^e:fgh^i^I:l^o:p:r:s:t:v:w:x:"
173 /*******************************************************************************
181 * DESCRIPTION: Display option help message
183 ******************************************************************************/
190 printf ("Global:\n");
191 printf (" -@<file> Specify command file\n");
192 printf (" -I<dir> Specify additional include directory\n");
194 printf ("\nGeneral Output:\n");
195 printf (" -p<prefix> Specify path/filename prefix for all output files\n");
196 printf (" -va Disable all errors and warnings (summary only)\n");
197 printf (" -vi Less verbose errors and warnings for use with IDEs\n");
198 printf (" -vo Enable optimization comments\n");
199 printf (" -vr Disable remarks\n");
200 printf (" -vs Disable signon\n");
201 printf (" -w<1|2|3> Set warning reporting level\n");
203 printf ("\nAML Output Files:\n");
204 printf (" -s<a|c> Create AML in assembler or C source file (*.asm or *.c)\n");
205 printf (" -i<a|c> Create assembler or C include file (*.inc or *.h)\n");
206 printf (" -t<a|c> Create AML in assembler or C hex table (*.hex)\n");
208 printf ("\nAML Code Generation:\n");
209 printf (" -oa Disable all optimizations (compatibility mode)\n");
210 printf (" -of Disable constant folding\n");
211 printf (" -oi Disable integer optimization to Zero/One/Ones\n");
212 printf (" -on Disable named reference string optimization\n");
213 printf (" -r<Revision> Override table header Revision (1-255)\n");
215 printf ("\nListings:\n");
216 printf (" -l Create mixed listing file (ASL source and AML) (*.lst)\n");
217 printf (" -ln Create namespace file (*.nsp)\n");
218 printf (" -ls Create combined source file (expanded includes) (*.src)\n");
220 printf ("\nAML Disassembler:\n");
221 printf (" -d [file] Disassemble or decode binary ACPI table to file (*.dsl)\n");
222 printf (" -dc [file] Disassemble AML and immediately compile it\n");
223 printf (" (Obtain DSDT from current system if no input file)\n");
224 printf (" -e [f1,f2] Include ACPI table(s) for external symbol resolution\n");
225 printf (" -2 Emit ACPI 2.0 compatible ASL code\n");
226 printf (" -g Get ACPI tables and write to files (*.dat)\n");
228 printf ("\nHelp:\n");
229 printf (" -h Additional help and compiler debug options\n");
230 printf (" -hc Display operators allowed in constant expressions\n");
231 printf (" -hr Display ACPI reserved method names\n");
235 /*******************************************************************************
237 * FUNCTION: HelpMessage
243 * DESCRIPTION: Display help message
245 ******************************************************************************/
252 printf ("AML output filename generation:\n");
253 printf (" Output filenames are generated by appending an extension to a common\n");
254 printf (" filename prefix. The filename prefix is obtained via one of the\n");
255 printf (" following methods (in priority order):\n");
256 printf (" 1) The -p option specifies the prefix\n");
257 printf (" 2) The prefix of the AMLFileName in the ASL Definition Block\n");
258 printf (" 3) The prefix of the input filename\n");
263 printf ("\nCompiler/Disassembler Debug Options:\n");
264 printf (" -b<p|t|b> Create compiler debug/trace file (*.txt)\n");
265 printf (" Types: Parse/Tree/Both\n");
266 printf (" -f Ignore errors, force creation of AML output file(s)\n");
267 printf (" -c Parse only, no output generation\n");
268 printf (" -ot Display compile times\n");
269 printf (" -x<level> Set debug level for trace output\n");
273 /*******************************************************************************
281 * DESCRIPTION: Display usage and option message
283 ******************************************************************************/
290 printf ("Usage: %s [Options] [Files]\n\n", CompilerName);
295 /*******************************************************************************
297 * FUNCTION: AslInitialize
303 * DESCRIPTION: Initialize compiler globals
305 ******************************************************************************/
315 _CrtSetDbgFlag (_CRTDBG_CHECK_ALWAYS_DF | _CrtSetDbgFlag(0));
320 for (i = 0; i < ASL_NUM_FILES; i++)
322 Gbl_Files[i].Handle = NULL;
323 Gbl_Files[i].Filename = NULL;
326 Gbl_Files[ASL_FILE_STDOUT].Handle = stdout;
327 Gbl_Files[ASL_FILE_STDOUT].Filename = "STDOUT";
329 Gbl_Files[ASL_FILE_STDERR].Handle = stderr;
330 Gbl_Files[ASL_FILE_STDERR].Filename = "STDERR";
334 /*******************************************************************************
336 * FUNCTION: AslMergeOptionTokens
338 * PARAMETERS: InBuffer - Input containing an option string
339 * OutBuffer - Merged output buffer
343 * DESCRIPTION: Remove all whitespace from an option string.
345 ******************************************************************************/
348 AslMergeOptionTokens (
357 Token = strtok (InBuffer, ASL_TOKEN_SEPARATORS);
360 strcat (OutBuffer, Token);
361 Token = strtok (NULL, ASL_TOKEN_SEPARATORS);
366 /*******************************************************************************
368 * FUNCTION: AslDoResponseFile
370 * PARAMETERS: Filename - Name of the response file
374 * DESCRIPTION: Open a response file and process all options within.
376 ******************************************************************************/
382 char *argv = StringBuffer2;
389 ResponseFile = fopen (Filename, "r");
392 printf ("Could not open command file %s, %s\n",
393 Filename, strerror (errno));
397 /* Must save the current GetOpt globals */
399 Opterr = AcpiGbl_Opterr;
400 Optind = AcpiGbl_Optind;
403 * Process all lines in the response file. There must be one complete
406 while (fgets (StringBuffer, ASL_MSG_BUFFER_SIZE, ResponseFile))
408 /* Compress all tokens, allowing us to use a single argv entry */
410 AslMergeOptionTokens (StringBuffer, StringBuffer2);
412 /* Process the option */
417 OptStatus = AslDoOptions (1, &argv, TRUE);
420 printf ("Invalid option in command file %s: %s\n",
421 Filename, StringBuffer);
426 /* Restore the GetOpt globals */
428 AcpiGbl_Opterr = Opterr;
429 AcpiGbl_Optind = Optind;
431 fclose (ResponseFile);
436 /*******************************************************************************
438 * FUNCTION: AslDoOptions
440 * PARAMETERS: argc/argv - Standard argc/argv
441 * IsResponseFile - TRUE if executing a response file.
445 * DESCRIPTION: Command line option processing
447 ******************************************************************************/
453 BOOLEAN IsResponseFile)
458 /* Get the command line options */
460 while ((j = AcpiGetopt (argc, argv, ASL_SUPPORTED_OPTIONS)) != EOF) switch (j)
462 case '@': /* Begin a response file */
466 printf ("Nested command files are not supported\n");
470 if (AslDoResponseFile (AcpiGbl_Optarg))
485 switch (AcpiGbl_Optarg[0])
488 AslCompilerdebug = 1; /* same as yydebug */
492 AslCompilerdebug = 1; /* same as yydebug */
499 printf ("Unknown option: -b%s\n", AcpiGbl_Optarg);
503 /* Produce debug output file */
505 Gbl_DebugFlag = TRUE;
513 Gbl_ParseOnlyFlag = TRUE;
518 switch (AcpiGbl_Optarg[0])
521 Gbl_DoCompile = FALSE;
528 printf ("Unknown option: -d%s\n", AcpiGbl_Optarg);
532 Gbl_DisasmFlag = TRUE;
537 Gbl_ExternalFilename = AcpiGbl_Optarg;
543 /* Ignore errors and force creation of aml file */
545 Gbl_IgnoreErrors = TRUE;
551 /* Get all ACPI tables */
553 Gbl_GetAllTables = TRUE;
554 Gbl_DoCompile = FALSE;
560 switch (AcpiGbl_Optarg[0])
567 UtDisplayConstantOpcodes ();
573 ApDisplayReservedNames ();
577 printf ("Unknown option: -h%s\n", AcpiGbl_Optarg);
583 case 'I': /* Add an include file search directory */
585 FlAddIncludeDirectory (AcpiGbl_Optarg);
591 switch (AcpiGbl_Optarg[0])
595 /* Produce assembly code include file */
597 Gbl_AsmIncludeOutputFlag = TRUE;
602 /* Produce C include file */
604 Gbl_C_IncludeOutputFlag = TRUE;
608 printf ("Unknown option: -s%s\n", AcpiGbl_Optarg);
616 switch (AcpiGbl_Optarg[0])
619 /* Produce listing file (Mixed source/aml) */
621 Gbl_ListingFlag = TRUE;
625 /* Produce namespace file */
627 Gbl_NsOutputFlag = TRUE;
631 /* Produce combined source file */
633 Gbl_SourceOutputFlag = TRUE;
637 printf ("Unknown option: -l%s\n", AcpiGbl_Optarg);
645 switch (AcpiGbl_Optarg[0])
649 /* Disable all optimizations */
651 Gbl_FoldConstants = FALSE;
652 Gbl_IntegerOptimizationFlag = FALSE;
653 Gbl_ReferenceOptimizationFlag = FALSE;
658 /* Disable folding on "normal" expressions */
660 Gbl_FoldConstants = FALSE;
665 /* Disable integer optimization to constants */
667 Gbl_IntegerOptimizationFlag = FALSE;
672 /* Disable named reference optimization */
674 Gbl_ReferenceOptimizationFlag = FALSE;
679 /* Display compile time(s) */
681 Gbl_CompileTimesFlag = TRUE;
685 printf ("Unknown option: -c%s\n", AcpiGbl_Optarg);
693 /* Override default AML output filename */
695 Gbl_OutputFilenamePrefix = AcpiGbl_Optarg;
696 Gbl_UseDefaultAmlFilename = FALSE;
701 Gbl_RevisionOverride = (UINT8) strtoul (AcpiGbl_Optarg, NULL, 0);
707 switch (AcpiGbl_Optarg[0])
711 /* Produce assembly code output file */
713 Gbl_AsmOutputFlag = TRUE;
718 /* Produce C hex output file */
720 Gbl_C_OutputFlag = TRUE;
724 printf ("Unknown option: -s%s\n", AcpiGbl_Optarg);
732 /* Produce hex table output file */
734 switch (AcpiGbl_Optarg[0])
737 Gbl_HexOutputFlag = HEX_OUTPUT_ASM;
741 Gbl_HexOutputFlag = HEX_OUTPUT_C;
745 printf ("Unknown option: -t%s\n", AcpiGbl_Optarg);
753 switch (AcpiGbl_Optarg[0])
756 /* Disable All error/warning messages */
762 /* Less verbose error messages */
764 Gbl_VerboseErrors = FALSE;
768 Gbl_DisplayOptimizations = TRUE;
772 Gbl_DisplayRemarks = FALSE;
776 Gbl_DoSignon = FALSE;
780 printf ("Unknown option: -v%s\n", AcpiGbl_Optarg);
786 case 'w': /* Set warning levels */
788 switch (AcpiGbl_Optarg[0])
791 Gbl_WarningLevel = ASL_WARNING;
795 Gbl_WarningLevel = ASL_WARNING2;
799 Gbl_WarningLevel = ASL_WARNING3;
803 printf ("Unknown option: -w%s\n", AcpiGbl_Optarg);
811 AcpiDbgLevel = strtoul (AcpiGbl_Optarg, NULL, 16);
824 /*******************************************************************************
826 * FUNCTION: AslCommandLine
828 * PARAMETERS: argc/argv
830 * RETURN: Last argv index
832 * DESCRIPTION: Command line processing
834 ******************************************************************************/
841 int BadCommandLine = 0;
844 /* Minimum command line contains at least the command and an input file */
848 AslCompilerSignon (ASL_FILE_STDOUT);
853 /* Process all command line options */
855 BadCommandLine = AslDoOptions (argc, argv, FALSE);
857 /* Next parameter must be the input filename */
859 if (!argv[AcpiGbl_Optind] &&
863 printf ("Missing input filename\n");
864 BadCommandLine = TRUE;
869 AslCompilerSignon (ASL_FILE_STDOUT);
872 /* Abort if anything went wrong on the command line */
881 return (AcpiGbl_Optind);
885 /*******************************************************************************
889 * PARAMETERS: Standard argc/argv
891 * RETURN: Program termination code
893 * DESCRIPTION: C main routine for the Asl Compiler. Handle command line
894 * options and begin the compile for each file on the command line
896 ******************************************************************************/
898 int ACPI_SYSTEM_XFACE
908 _CrtSetDbgFlag (_CRTDBG_CHECK_ALWAYS_DF | _CRTDBG_LEAK_CHECK_DF |
909 _CrtSetDbgFlag(_CRTDBG_REPORT_FLAG));
912 /* Init and command line */
915 Index = AslCommandLine (argc, argv);
917 /* Options that have no additional parameters or pathnames */
919 if (Gbl_GetAllTables)
921 Status = AslDoOneFile (NULL);
922 if (ACPI_FAILURE (Status))
929 /* Process each pathname/filename in the list, with possible wildcards */
933 Status = AslDoOnePathname (argv[Index]);
934 if (ACPI_FAILURE (Status))