1 /******************************************************************************
3 * Module Name: asloptions - compiler command line processing
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2017, 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 <contrib/dev/acpica/compiler/aslcompiler.h>
153 #include <contrib/dev/acpica/include/acapps.h>
154 #include <contrib/dev/acpica/include/acdisasm.h>
156 #define _COMPONENT ACPI_COMPILER
157 ACPI_MODULE_NAME ("asloption")
160 /* Local prototypes */
166 BOOLEAN IsResponseFile);
169 AslMergeOptionTokens (
178 #define ASL_TOKEN_SEPARATORS " \t\n"
179 #define ASL_SUPPORTED_OPTIONS "@:a:b|c|d^D:e:f^gh^i|I:l^m:no|p:P^q^r:s|t|T+G^v^w|x:z"
182 /*******************************************************************************
184 * FUNCTION: AslCommandLine
186 * PARAMETERS: argc/argv
188 * RETURN: Last argv index
190 * DESCRIPTION: Command line processing
192 ******************************************************************************/
199 int BadCommandLine = 0;
203 /* Minimum command line contains at least the command and an input file */
211 /* Process all command line options */
213 BadCommandLine = AslDoOptions (argc, argv, FALSE);
217 Status = DtCreateTemplates (argv);
218 if (ACPI_FAILURE (Status))
225 /* Next parameter must be the input filename */
227 if (!argv[AcpiGbl_Optind] &&
230 printf ("Missing input filename\n");
231 BadCommandLine = TRUE;
236 printf (ACPI_COMMON_SIGNON (ASL_COMPILER_NAME));
237 if (Gbl_IgnoreErrors)
239 printf ("Ignoring all errors, forcing AML file generation\n\n");
245 printf ("Use -h option for help information\n");
249 return (AcpiGbl_Optind);
253 /*******************************************************************************
255 * FUNCTION: AslDoOptions
257 * PARAMETERS: argc/argv - Standard argc/argv
258 * IsResponseFile - TRUE if executing a response file.
262 * DESCRIPTION: Command line option processing
264 ******************************************************************************/
270 BOOLEAN IsResponseFile)
276 /* Get the command line options */
278 while ((j = AcpiGetopt (argc, argv, ASL_SUPPORTED_OPTIONS)) != ACPI_OPT_END) switch (j)
280 case '@': /* Begin a response file */
284 printf ("Nested command files are not supported\n");
288 if (AslDoResponseFile (AcpiGbl_Optarg))
294 case 'a': /* Debug options */
296 switch (AcpiGbl_Optarg[0])
300 Gbl_EnableReferenceTypechecking = TRUE;
305 printf ("Unknown option: -a%s\n", AcpiGbl_Optarg);
312 case 'b': /* Debug options */
314 switch (AcpiGbl_Optarg[0])
319 printf ("Debug ASL to ASL+ conversion\n");
321 Gbl_DoAslConversion = TRUE;
322 Gbl_FoldConstants = FALSE;
323 Gbl_IntegerOptimizationFlag = FALSE;
324 Gbl_ReferenceOptimizationFlag = FALSE;
325 Gbl_OptimizeTrivialParseNodes = FALSE;
326 Gbl_CaptureComments = TRUE;
327 AcpiGbl_DoDisassemblerOptimizations = FALSE;
328 AcpiGbl_DebugAslConversion = TRUE;
329 AcpiGbl_DmEmitExternalOpcodes = TRUE;
330 Gbl_DoExternalsInPlace = TRUE;
336 AslCompilerdebug = 1; /* same as yydebug */
339 Gbl_DebugFlag = TRUE;
340 Gbl_KeepPreprocessorTempFile = TRUE;
343 case 'p': /* Prune ASL parse tree */
345 /* Get the required argument */
347 if (AcpiGetoptArgument (argc, argv))
352 Gbl_PruneParseTree = TRUE;
353 Gbl_PruneDepth = (UINT8) strtoul (AcpiGbl_Optarg, NULL, 0);
358 Gbl_DebugFlag = TRUE;
363 /* Get the required argument */
365 if (AcpiGetoptArgument (argc, argv))
370 Gbl_PruneType = (UINT8) strtoul (AcpiGbl_Optarg, NULL, 0);
375 printf ("Unknown option: -b%s\n", AcpiGbl_Optarg);
383 switch (AcpiGbl_Optarg[0])
388 printf ("Convert ASL to ASL+ with comments\n");
389 Gbl_DoAslConversion = TRUE;
390 Gbl_FoldConstants = FALSE;
391 Gbl_IntegerOptimizationFlag = FALSE;
392 Gbl_ReferenceOptimizationFlag = FALSE;
393 Gbl_OptimizeTrivialParseNodes = FALSE;
394 Gbl_CaptureComments = TRUE;
395 AcpiGbl_DoDisassemblerOptimizations = FALSE;
396 AcpiGbl_DmEmitExternalOpcodes = TRUE;
397 Gbl_DoExternalsInPlace = TRUE;
403 Gbl_NoResourceChecking = TRUE;
408 printf ("Unknown option: -c%s\n", AcpiGbl_Optarg);
413 case 'd': /* Disassembler */
415 switch (AcpiGbl_Optarg[0])
419 /* Get the required argument */
421 if (AcpiGetoptArgument (argc, argv))
426 Gbl_DoCompile = FALSE;
431 /* Get the required argument */
433 if (AcpiGetoptArgument (argc, argv))
438 Gbl_DoCompile = FALSE;
439 Gbl_DisassembleAll = TRUE;
442 case 'b': /* Do not convert buffers to resource descriptors */
444 AcpiGbl_NoResourceDisassembly = TRUE;
453 AcpiGbl_ForceAmlDisassembly = TRUE;
456 case 'l': /* Use legacy ASL code (not ASL+) for disassembly */
458 Gbl_DoCompile = FALSE;
459 AcpiGbl_CstyleDisassembly = FALSE;
464 printf ("Unknown option: -d%s\n", AcpiGbl_Optarg);
468 AcpiGbl_DisasmFlag = TRUE;
471 case 'D': /* Define a symbol */
473 PrAddDefine (AcpiGbl_Optarg, NULL, TRUE);
476 case 'e': /* External files for disassembler */
478 /* Get entire list of external files */
481 argv[AcpiGbl_Optind] = AcpiGbl_Optarg;
483 while (argv[AcpiGbl_Optind] &&
484 (argv[AcpiGbl_Optind][0] != '-'))
486 Status = AcpiDmAddToExternalFileList (argv[AcpiGbl_Optind]);
487 if (ACPI_FAILURE (Status))
489 printf ("Could not add %s to external list\n",
490 argv[AcpiGbl_Optind]);
500 switch (AcpiGbl_Optarg[0])
502 case '^': /* Ignore errors and force creation of aml file */
504 Gbl_IgnoreErrors = TRUE;
507 case 'e': /* Disassembler: Get external declaration file */
509 if (AcpiGetoptArgument (argc, argv))
514 Gbl_ExternalRefFilename = AcpiGbl_Optarg;
519 printf ("Unknown option: -f%s\n", AcpiGbl_Optarg);
526 Gbl_CompileGeneric = TRUE;
529 case 'g': /* Get all ACPI tables */
531 printf ("-g option is deprecated, use acpidump utility instead\n");
536 switch (AcpiGbl_Optarg[0])
545 UtDisplayConstantOpcodes ();
550 AslDisassemblyHelp ();
562 ApDisplayReservedNames ();
567 UtDisplaySupportedTables ();
572 printf ("Unknown option: -h%s\n", AcpiGbl_Optarg);
576 case 'I': /* Add an include file search directory */
578 FlAddIncludeDirectory (AcpiGbl_Optarg);
581 case 'i': /* Output AML as an include file */
583 switch (AcpiGbl_Optarg[0])
587 /* Produce assembly code include file */
589 Gbl_AsmIncludeOutputFlag = TRUE;
594 /* Produce C include file */
596 Gbl_C_IncludeOutputFlag = TRUE;
601 /* Compiler/Disassembler: Ignore the NOOP operator */
603 AcpiGbl_IgnoreNoopOperator = TRUE;
608 printf ("Unknown option: -i%s\n", AcpiGbl_Optarg);
613 case 'l': /* Listing files */
615 switch (AcpiGbl_Optarg[0])
619 /* Produce listing file (Mixed source/aml) */
621 Gbl_ListingFlag = TRUE;
622 AcpiGbl_DmOpt_Listing = TRUE;
627 /* Produce preprocessor output file */
629 Gbl_PreprocessorOutputFlag = TRUE;
634 /* Produce hardware map summary file */
636 Gbl_MapfileFlag = TRUE;
641 /* Produce namespace file */
643 Gbl_NsOutputFlag = TRUE;
648 /* Produce combined source file */
650 Gbl_SourceOutputFlag = TRUE;
655 /* Produce cross-reference file */
657 Gbl_CrossReferenceOutput = TRUE;
662 printf ("Unknown option: -l%s\n", AcpiGbl_Optarg);
667 case 'm': /* Set line buffer size */
669 Gbl_LineBufferSize = (UINT32) strtoul (AcpiGbl_Optarg, NULL, 0) * 1024;
670 if (Gbl_LineBufferSize < ASL_DEFAULT_LINE_BUFFER_SIZE)
672 Gbl_LineBufferSize = ASL_DEFAULT_LINE_BUFFER_SIZE;
674 printf ("Line Buffer Size: %u\n", Gbl_LineBufferSize);
677 case 'n': /* Parse only */
679 Gbl_ParseOnlyFlag = TRUE;
682 case 'o': /* Control compiler AML optimizations */
684 switch (AcpiGbl_Optarg[0])
688 /* Disable all optimizations */
690 Gbl_FoldConstants = FALSE;
691 Gbl_IntegerOptimizationFlag = FALSE;
692 Gbl_ReferenceOptimizationFlag = FALSE;
693 Gbl_OptimizeTrivialParseNodes = FALSE;
699 /* Display compile time(s) */
701 Gbl_CompileTimesFlag = TRUE;
706 /* Disable disassembler code optimizations */
708 AcpiGbl_DoDisassemblerOptimizations = FALSE;
713 /* Disassembler: Emit embedded external operators */
715 AcpiGbl_DmEmitExternalOpcodes = TRUE;
721 * iASL: keep External opcodes in place.
722 * No affect if Gbl_DoExternals is false.
725 Gbl_DoExternalsInPlace = TRUE;
730 /* Disable folding on "normal" expressions */
732 Gbl_FoldConstants = FALSE;
737 /* Disable integer optimization to constants */
739 Gbl_IntegerOptimizationFlag = FALSE;
744 /* Disable named reference optimization */
746 Gbl_ReferenceOptimizationFlag = FALSE;
751 /* Disable heavy typechecking */
753 Gbl_DoTypechecking = FALSE;
758 printf ("Unknown option: -c%s\n", AcpiGbl_Optarg);
763 case 'P': /* Preprocessor options */
765 switch (AcpiGbl_Optarg[0])
767 case '^': /* Proprocess only, emit (.i) file */
769 Gbl_PreprocessOnly = TRUE;
770 Gbl_PreprocessorOutputFlag = TRUE;
773 case 'n': /* Disable preprocessor */
775 Gbl_PreprocessFlag = FALSE;
780 printf ("Unknown option: -P%s\n", AcpiGbl_Optarg);
785 case 'p': /* Override default AML output filename */
787 Gbl_OutputFilenamePrefix = AcpiGbl_Optarg;
788 UtConvertBackslashes (Gbl_OutputFilenamePrefix);
789 Gbl_UseDefaultAmlFilename = FALSE;
792 case 'q': /* ASL/ASl+ converter: compile only and leave badaml. */
794 printf ("Convert ASL to ASL+ with comments\n");
795 Gbl_FoldConstants = FALSE;
796 Gbl_IntegerOptimizationFlag = FALSE;
797 Gbl_ReferenceOptimizationFlag = FALSE;
798 Gbl_OptimizeTrivialParseNodes = FALSE;
799 Gbl_CaptureComments = TRUE;
800 Gbl_DoExternalsInPlace = TRUE;
803 case 'r': /* Override revision found in table header */
805 Gbl_RevisionOverride = (UINT8) strtoul (AcpiGbl_Optarg, NULL, 0);
808 case 's': /* Create AML in a source code file */
810 switch (AcpiGbl_Optarg[0])
814 /* Produce assembly code output file */
816 Gbl_AsmOutputFlag = TRUE;
821 /* Produce C hex output file */
823 Gbl_C_OutputFlag = TRUE;
828 /* Produce AML offset table in C */
830 Gbl_C_OffsetTableFlag = TRUE;
835 printf ("Unknown option: -s%s\n", AcpiGbl_Optarg);
840 case 't': /* Produce hex table output file */
842 switch (AcpiGbl_Optarg[0])
846 Gbl_HexOutputFlag = HEX_OUTPUT_ASM;
851 Gbl_HexOutputFlag = HEX_OUTPUT_C;
856 Gbl_HexOutputFlag = HEX_OUTPUT_ASL;
861 printf ("Unknown option: -t%s\n", AcpiGbl_Optarg);
866 case 'T': /* Create a ACPI table template file */
868 Gbl_DoTemplates = TRUE;
871 case 'v': /* Version and verbosity settings */
873 switch (AcpiGbl_Optarg[0])
877 printf (ACPI_COMMON_SIGNON (ASL_COMPILER_NAME));
882 /* Disable all error/warning/remark messages */
889 /* Disable all warning/remark messages (errors only) */
891 Gbl_DisplayRemarks = FALSE;
892 Gbl_DisplayWarnings = FALSE;
897 * Support for integrated development environment(s).
899 * 1) No compiler signon
900 * 2) Send stderr messages to stdout
901 * 3) Less verbose error messages (single line only for each)
902 * 4) Error/warning messages are formatted appropriately to
903 * be recognized by MS Visual Studio
905 Gbl_VerboseErrors = FALSE;
906 Gbl_DoSignon = FALSE;
907 Gbl_Files[ASL_FILE_STDERR].Handle = stdout;
912 Gbl_DisplayOptimizations = TRUE;
917 Gbl_DisplayRemarks = FALSE;
922 Gbl_DoSignon = FALSE;
927 Gbl_VerboseTemplates = TRUE;
932 /* Get the required argument */
934 if (AcpiGetoptArgument (argc, argv))
939 Status = AslDisableException (AcpiGbl_Optarg);
940 if (ACPI_FAILURE (Status))
948 /* Get the required argument */
950 if (AcpiGetoptArgument (argc, argv))
955 Status = AslExpectException (AcpiGbl_Optarg);
956 if (ACPI_FAILURE (Status))
964 printf ("Unknown option: -v%s\n", AcpiGbl_Optarg);
969 case 'w': /* Set warning levels */
971 switch (AcpiGbl_Optarg[0])
975 Gbl_WarningLevel = ASL_WARNING;
980 Gbl_WarningLevel = ASL_WARNING2;
985 Gbl_WarningLevel = ASL_WARNING3;
990 Gbl_WarningsAsErrors = TRUE;
995 printf ("Unknown option: -w%s\n", AcpiGbl_Optarg);
1000 case 'x': /* Set debug print output level */
1002 AcpiDbgLevel = strtoul (AcpiGbl_Optarg, NULL, 16);
1007 Gbl_UseOriginalCompilerId = TRUE;
1019 /*******************************************************************************
1021 * FUNCTION: AslMergeOptionTokens
1023 * PARAMETERS: InBuffer - Input containing an option string
1024 * OutBuffer - Merged output buffer
1028 * DESCRIPTION: Remove all whitespace from an option string.
1030 ******************************************************************************/
1033 AslMergeOptionTokens (
1042 Token = strtok (InBuffer, ASL_TOKEN_SEPARATORS);
1045 strcat (OutBuffer, Token);
1046 Token = strtok (NULL, ASL_TOKEN_SEPARATORS);
1051 /*******************************************************************************
1053 * FUNCTION: AslDoResponseFile
1055 * PARAMETERS: Filename - Name of the response file
1059 * DESCRIPTION: Open a response file and process all options within.
1061 ******************************************************************************/
1067 char *argv = StringBuffer2;
1074 ResponseFile = fopen (Filename, "r");
1077 printf ("Could not open command file %s, %s\n",
1078 Filename, strerror (errno));
1082 /* Must save the current GetOpt globals */
1084 Opterr = AcpiGbl_Opterr;
1085 Optind = AcpiGbl_Optind;
1088 * Process all lines in the response file. There must be one complete
1091 while (fgets (StringBuffer, ASL_MSG_BUFFER_SIZE, ResponseFile))
1093 /* Compress all tokens, allowing us to use a single argv entry */
1095 AslMergeOptionTokens (StringBuffer, StringBuffer2);
1097 /* Process the option */
1102 OptStatus = AslDoOptions (1, &argv, TRUE);
1105 printf ("Invalid option in command file %s: %s\n",
1106 Filename, StringBuffer);
1111 /* Restore the GetOpt globals */
1113 AcpiGbl_Opterr = Opterr;
1114 AcpiGbl_Optind = Optind;
1116 fclose (ResponseFile);