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 */
207 printf (ACPI_COMMON_SIGNON (ASL_COMPILER_NAME));
212 /* Process all command line options */
214 BadCommandLine = AslDoOptions (argc, argv, FALSE);
218 Status = DtCreateTemplates (argv);
219 if (ACPI_FAILURE (Status))
226 /* Next parameter must be the input filename */
228 if (!argv[AcpiGbl_Optind] &&
231 printf ("Missing input filename\n");
232 BadCommandLine = TRUE;
237 printf (ACPI_COMMON_SIGNON (ASL_COMPILER_NAME));
238 if (Gbl_IgnoreErrors)
240 printf ("Ignoring all errors, forcing AML file generation\n\n");
246 printf ("Use -h option for help information\n");
250 return (AcpiGbl_Optind);
254 /*******************************************************************************
256 * FUNCTION: AslDoOptions
258 * PARAMETERS: argc/argv - Standard argc/argv
259 * IsResponseFile - TRUE if executing a response file.
263 * DESCRIPTION: Command line option processing
265 ******************************************************************************/
271 BOOLEAN IsResponseFile)
277 /* Get the command line options */
279 while ((j = AcpiGetopt (argc, argv, ASL_SUPPORTED_OPTIONS)) != ACPI_OPT_END) switch (j)
281 case '@': /* Begin a response file */
285 printf ("Nested command files are not supported\n");
289 if (AslDoResponseFile (AcpiGbl_Optarg))
295 case 'a': /* Debug options */
297 switch (AcpiGbl_Optarg[0])
301 Gbl_EnableReferenceTypechecking = TRUE;
306 printf ("Unknown option: -a%s\n", AcpiGbl_Optarg);
313 case 'b': /* Debug options */
315 switch (AcpiGbl_Optarg[0])
320 printf ("Debug ASL to ASL+ conversion\n");
322 Gbl_DoAslConversion = TRUE;
323 Gbl_FoldConstants = FALSE;
324 Gbl_IntegerOptimizationFlag = FALSE;
325 Gbl_ReferenceOptimizationFlag = FALSE;
326 Gbl_OptimizeTrivialParseNodes = FALSE;
327 Gbl_CaptureComments = TRUE;
328 AcpiGbl_DoDisassemblerOptimizations = FALSE;
329 AcpiGbl_DebugAslConversion = TRUE;
330 AcpiGbl_DmEmitExternalOpcodes = TRUE;
331 Gbl_DoExternalsInPlace = TRUE;
337 AslCompilerdebug = 1; /* same as yydebug */
340 Gbl_DebugFlag = TRUE;
341 Gbl_KeepPreprocessorTempFile = TRUE;
344 case 'p': /* Prune ASL parse tree */
346 /* Get the required argument */
348 if (AcpiGetoptArgument (argc, argv))
353 Gbl_PruneParseTree = TRUE;
354 Gbl_PruneDepth = (UINT8) strtoul (AcpiGbl_Optarg, NULL, 0);
359 Gbl_DebugFlag = TRUE;
364 /* Get the required argument */
366 if (AcpiGetoptArgument (argc, argv))
371 Gbl_PruneType = (UINT8) strtoul (AcpiGbl_Optarg, NULL, 0);
376 printf ("Unknown option: -b%s\n", AcpiGbl_Optarg);
384 switch (AcpiGbl_Optarg[0])
389 printf ("Convert ASL to ASL+ with comments\n");
390 Gbl_DoAslConversion = TRUE;
391 Gbl_FoldConstants = FALSE;
392 Gbl_IntegerOptimizationFlag = FALSE;
393 Gbl_ReferenceOptimizationFlag = FALSE;
394 Gbl_OptimizeTrivialParseNodes = FALSE;
395 Gbl_CaptureComments = TRUE;
396 AcpiGbl_DoDisassemblerOptimizations = FALSE;
397 AcpiGbl_DmEmitExternalOpcodes = TRUE;
398 Gbl_DoExternalsInPlace = TRUE;
404 Gbl_NoResourceChecking = TRUE;
409 printf ("Unknown option: -c%s\n", AcpiGbl_Optarg);
414 case 'd': /* Disassembler */
416 switch (AcpiGbl_Optarg[0])
420 /* Get the required argument */
422 if (AcpiGetoptArgument (argc, argv))
427 Gbl_DoCompile = FALSE;
432 /* Get the required argument */
434 if (AcpiGetoptArgument (argc, argv))
439 Gbl_DoCompile = FALSE;
440 Gbl_DisassembleAll = TRUE;
443 case 'b': /* Do not convert buffers to resource descriptors */
445 AcpiGbl_NoResourceDisassembly = TRUE;
454 AcpiGbl_ForceAmlDisassembly = TRUE;
457 case 'l': /* Use legacy ASL code (not ASL+) for disassembly */
459 Gbl_DoCompile = FALSE;
460 AcpiGbl_CstyleDisassembly = FALSE;
465 printf ("Unknown option: -d%s\n", AcpiGbl_Optarg);
469 AcpiGbl_DisasmFlag = TRUE;
472 case 'D': /* Define a symbol */
474 PrAddDefine (AcpiGbl_Optarg, NULL, TRUE);
477 case 'e': /* External files for disassembler */
479 /* Get entire list of external files */
482 argv[AcpiGbl_Optind] = AcpiGbl_Optarg;
484 while (argv[AcpiGbl_Optind] &&
485 (argv[AcpiGbl_Optind][0] != '-'))
487 Status = AcpiDmAddToExternalFileList (argv[AcpiGbl_Optind]);
488 if (ACPI_FAILURE (Status))
490 printf ("Could not add %s to external list\n",
491 argv[AcpiGbl_Optind]);
501 switch (AcpiGbl_Optarg[0])
503 case '^': /* Ignore errors and force creation of aml file */
505 Gbl_IgnoreErrors = TRUE;
508 case 'e': /* Disassembler: Get external declaration file */
510 if (AcpiGetoptArgument (argc, argv))
515 Gbl_ExternalRefFilename = AcpiGbl_Optarg;
520 printf ("Unknown option: -f%s\n", AcpiGbl_Optarg);
527 Gbl_CompileGeneric = TRUE;
530 case 'g': /* Get all ACPI tables */
532 printf ("-g option is deprecated, use acpidump utility instead\n");
537 switch (AcpiGbl_Optarg[0])
541 printf (ACPI_COMMON_SIGNON (ASL_COMPILER_NAME));
547 UtDisplayConstantOpcodes ();
552 AslDisassemblyHelp ();
564 ApDisplayReservedNames ();
569 UtDisplaySupportedTables ();
574 printf ("Unknown option: -h%s\n", AcpiGbl_Optarg);
578 case 'I': /* Add an include file search directory */
580 FlAddIncludeDirectory (AcpiGbl_Optarg);
583 case 'i': /* Output AML as an include file */
585 switch (AcpiGbl_Optarg[0])
589 /* Produce assembly code include file */
591 Gbl_AsmIncludeOutputFlag = TRUE;
596 /* Produce C include file */
598 Gbl_C_IncludeOutputFlag = TRUE;
603 /* Compiler/Disassembler: Ignore the NOOP operator */
605 AcpiGbl_IgnoreNoopOperator = TRUE;
610 printf ("Unknown option: -i%s\n", AcpiGbl_Optarg);
615 case 'l': /* Listing files */
617 switch (AcpiGbl_Optarg[0])
621 /* Produce listing file (Mixed source/aml) */
623 Gbl_ListingFlag = TRUE;
624 AcpiGbl_DmOpt_Listing = TRUE;
629 /* Produce preprocessor output file */
631 Gbl_PreprocessorOutputFlag = TRUE;
636 /* Produce hardware map summary file */
638 Gbl_MapfileFlag = TRUE;
643 /* Produce namespace file */
645 Gbl_NsOutputFlag = TRUE;
650 /* Produce combined source file */
652 Gbl_SourceOutputFlag = TRUE;
657 /* Produce cross-reference file */
659 Gbl_CrossReferenceOutput = TRUE;
664 printf ("Unknown option: -l%s\n", AcpiGbl_Optarg);
669 case 'm': /* Set line buffer size */
671 Gbl_LineBufferSize = (UINT32) strtoul (AcpiGbl_Optarg, NULL, 0) * 1024;
672 if (Gbl_LineBufferSize < ASL_DEFAULT_LINE_BUFFER_SIZE)
674 Gbl_LineBufferSize = ASL_DEFAULT_LINE_BUFFER_SIZE;
676 printf ("Line Buffer Size: %u\n", Gbl_LineBufferSize);
679 case 'n': /* Parse only */
681 Gbl_ParseOnlyFlag = TRUE;
684 case 'o': /* Control compiler AML optimizations */
686 switch (AcpiGbl_Optarg[0])
690 /* Disable all optimizations */
692 Gbl_FoldConstants = FALSE;
693 Gbl_IntegerOptimizationFlag = FALSE;
694 Gbl_ReferenceOptimizationFlag = FALSE;
695 Gbl_OptimizeTrivialParseNodes = FALSE;
701 /* Display compile time(s) */
703 Gbl_CompileTimesFlag = TRUE;
708 /* Disable disassembler code optimizations */
710 AcpiGbl_DoDisassemblerOptimizations = FALSE;
715 /* Disassembler: Emit embedded external operators */
717 AcpiGbl_DmEmitExternalOpcodes = TRUE;
723 * iASL: keep External opcodes in place.
724 * No affect if Gbl_DoExternals is false.
727 Gbl_DoExternalsInPlace = TRUE;
732 /* Disable folding on "normal" expressions */
734 Gbl_FoldConstants = FALSE;
739 /* Disable integer optimization to constants */
741 Gbl_IntegerOptimizationFlag = FALSE;
746 /* Disable named reference optimization */
748 Gbl_ReferenceOptimizationFlag = FALSE;
753 /* Disable heavy typechecking */
755 Gbl_DoTypechecking = FALSE;
760 printf ("Unknown option: -c%s\n", AcpiGbl_Optarg);
765 case 'P': /* Preprocessor options */
767 switch (AcpiGbl_Optarg[0])
769 case '^': /* Proprocess only, emit (.i) file */
771 Gbl_PreprocessOnly = TRUE;
772 Gbl_PreprocessorOutputFlag = TRUE;
775 case 'n': /* Disable preprocessor */
777 Gbl_PreprocessFlag = FALSE;
782 printf ("Unknown option: -P%s\n", AcpiGbl_Optarg);
787 case 'p': /* Override default AML output filename */
789 Gbl_OutputFilenamePrefix = AcpiGbl_Optarg;
790 UtConvertBackslashes (Gbl_OutputFilenamePrefix);
791 Gbl_UseDefaultAmlFilename = FALSE;
794 case 'q': /* ASL/ASl+ converter: compile only and leave badaml. */
796 printf ("Convert ASL to ASL+ with comments\n");
797 Gbl_FoldConstants = FALSE;
798 Gbl_IntegerOptimizationFlag = FALSE;
799 Gbl_ReferenceOptimizationFlag = FALSE;
800 Gbl_OptimizeTrivialParseNodes = FALSE;
801 Gbl_CaptureComments = TRUE;
802 Gbl_DoExternalsInPlace = TRUE;
805 case 'r': /* Override revision found in table header */
807 Gbl_RevisionOverride = (UINT8) strtoul (AcpiGbl_Optarg, NULL, 0);
810 case 's': /* Create AML in a source code file */
812 switch (AcpiGbl_Optarg[0])
816 /* Produce assembly code output file */
818 Gbl_AsmOutputFlag = TRUE;
823 /* Produce C hex output file */
825 Gbl_C_OutputFlag = TRUE;
830 /* Produce AML offset table in C */
832 Gbl_C_OffsetTableFlag = TRUE;
837 printf ("Unknown option: -s%s\n", AcpiGbl_Optarg);
842 case 't': /* Produce hex table output file */
844 switch (AcpiGbl_Optarg[0])
848 Gbl_HexOutputFlag = HEX_OUTPUT_ASM;
853 Gbl_HexOutputFlag = HEX_OUTPUT_C;
858 Gbl_HexOutputFlag = HEX_OUTPUT_ASL;
863 printf ("Unknown option: -t%s\n", AcpiGbl_Optarg);
868 case 'T': /* Create a ACPI table template file */
870 Gbl_DoTemplates = TRUE;
873 case 'v': /* Version and verbosity settings */
875 switch (AcpiGbl_Optarg[0])
879 printf (ACPI_COMMON_SIGNON (ASL_COMPILER_NAME));
884 /* Disable all error/warning/remark messages */
891 /* Disable all warning/remark messages (errors only) */
893 Gbl_DisplayRemarks = FALSE;
894 Gbl_DisplayWarnings = FALSE;
899 * Support for integrated development environment(s).
901 * 1) No compiler signon
902 * 2) Send stderr messages to stdout
903 * 3) Less verbose error messages (single line only for each)
904 * 4) Error/warning messages are formatted appropriately to
905 * be recognized by MS Visual Studio
907 Gbl_VerboseErrors = FALSE;
908 Gbl_DoSignon = FALSE;
909 Gbl_Files[ASL_FILE_STDERR].Handle = stdout;
914 Gbl_DisplayOptimizations = TRUE;
919 Gbl_DisplayRemarks = FALSE;
924 Gbl_DoSignon = FALSE;
929 Gbl_VerboseTemplates = TRUE;
934 /* Get the required argument */
936 if (AcpiGetoptArgument (argc, argv))
941 Status = AslDisableException (AcpiGbl_Optarg);
942 if (ACPI_FAILURE (Status))
950 printf ("Unknown option: -v%s\n", AcpiGbl_Optarg);
955 case 'w': /* Set warning levels */
957 switch (AcpiGbl_Optarg[0])
961 Gbl_WarningLevel = ASL_WARNING;
966 Gbl_WarningLevel = ASL_WARNING2;
971 Gbl_WarningLevel = ASL_WARNING3;
976 Gbl_WarningsAsErrors = TRUE;
981 printf ("Unknown option: -w%s\n", AcpiGbl_Optarg);
986 case 'x': /* Set debug print output level */
988 AcpiDbgLevel = strtoul (AcpiGbl_Optarg, NULL, 16);
993 Gbl_UseOriginalCompilerId = TRUE;
1005 /*******************************************************************************
1007 * FUNCTION: AslMergeOptionTokens
1009 * PARAMETERS: InBuffer - Input containing an option string
1010 * OutBuffer - Merged output buffer
1014 * DESCRIPTION: Remove all whitespace from an option string.
1016 ******************************************************************************/
1019 AslMergeOptionTokens (
1028 Token = strtok (InBuffer, ASL_TOKEN_SEPARATORS);
1031 strcat (OutBuffer, Token);
1032 Token = strtok (NULL, ASL_TOKEN_SEPARATORS);
1037 /*******************************************************************************
1039 * FUNCTION: AslDoResponseFile
1041 * PARAMETERS: Filename - Name of the response file
1045 * DESCRIPTION: Open a response file and process all options within.
1047 ******************************************************************************/
1053 char *argv = StringBuffer2;
1060 ResponseFile = fopen (Filename, "r");
1063 printf ("Could not open command file %s, %s\n",
1064 Filename, strerror (errno));
1068 /* Must save the current GetOpt globals */
1070 Opterr = AcpiGbl_Opterr;
1071 Optind = AcpiGbl_Optind;
1074 * Process all lines in the response file. There must be one complete
1077 while (fgets (StringBuffer, ASL_MSG_BUFFER_SIZE, ResponseFile))
1079 /* Compress all tokens, allowing us to use a single argv entry */
1081 AslMergeOptionTokens (StringBuffer, StringBuffer2);
1083 /* Process the option */
1088 OptStatus = AslDoOptions (1, &argv, TRUE);
1091 printf ("Invalid option in command file %s: %s\n",
1092 Filename, StringBuffer);
1097 /* Restore the GetOpt globals */
1099 AcpiGbl_Opterr = Opterr;
1100 AcpiGbl_Optind = Optind;
1102 fclose (ResponseFile);