1 /******************************************************************************
3 * Module Name: asloptions - compiler command line processing
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2015, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
44 #include <contrib/dev/acpica/compiler/aslcompiler.h>
45 #include <contrib/dev/acpica/include/acapps.h>
46 #include <contrib/dev/acpica/include/acdisasm.h>
48 #define _COMPONENT ACPI_COMPILER
49 ACPI_MODULE_NAME ("asloption")
52 /* Local prototypes */
58 BOOLEAN IsResponseFile);
61 AslMergeOptionTokens (
70 #define ASL_TOKEN_SEPARATORS " \t\n"
71 #define ASL_SUPPORTED_OPTIONS "@:b|c|d^D:e:f^gh^i|I:l^m:no|p:P^r:s|t|T+G^v^w|x:z"
74 /*******************************************************************************
76 * FUNCTION: AslCommandLine
78 * PARAMETERS: argc/argv
80 * RETURN: Last argv index
82 * DESCRIPTION: Command line processing
84 ******************************************************************************/
91 int BadCommandLine = 0;
95 /* Minimum command line contains at least the command and an input file */
99 printf (ACPI_COMMON_SIGNON (ASL_COMPILER_NAME));
104 /* Process all command line options */
106 BadCommandLine = AslDoOptions (argc, argv, FALSE);
110 Status = DtCreateTemplates (Gbl_TemplateSignature);
111 if (ACPI_FAILURE (Status))
118 /* Next parameter must be the input filename */
120 if (!argv[AcpiGbl_Optind] &&
123 printf ("Missing input filename\n");
124 BadCommandLine = TRUE;
129 printf (ACPI_COMMON_SIGNON (ASL_COMPILER_NAME));
130 if (Gbl_IgnoreErrors)
132 printf ("Ignoring all errors, forcing AML file generation\n\n");
138 printf ("Use -h option for help information\n");
142 return (AcpiGbl_Optind);
146 /*******************************************************************************
148 * FUNCTION: AslDoOptions
150 * PARAMETERS: argc/argv - Standard argc/argv
151 * IsResponseFile - TRUE if executing a response file.
155 * DESCRIPTION: Command line option processing
157 ******************************************************************************/
163 BOOLEAN IsResponseFile)
169 /* Get the command line options */
171 while ((j = AcpiGetopt (argc, argv, ASL_SUPPORTED_OPTIONS)) != ACPI_OPT_END) switch (j)
173 case '@': /* Begin a response file */
177 printf ("Nested command files are not supported\n");
181 if (AslDoResponseFile (AcpiGbl_Optarg))
187 case 'b': /* Debug options */
189 switch (AcpiGbl_Optarg[0])
193 AslCompilerdebug = 1; /* same as yydebug */
196 Gbl_DebugFlag = TRUE;
197 Gbl_KeepPreprocessorTempFile = TRUE;
200 case 'p': /* Prune ASL parse tree */
202 /* Get the required argument */
204 if (AcpiGetoptArgument (argc, argv))
209 Gbl_PruneParseTree = TRUE;
210 Gbl_PruneDepth = (UINT8) strtoul (AcpiGbl_Optarg, NULL, 0);
215 Gbl_DebugFlag = TRUE;
220 /* Get the required argument */
222 if (AcpiGetoptArgument (argc, argv))
227 Gbl_PruneType = (UINT8) strtoul (AcpiGbl_Optarg, NULL, 0);
232 printf ("Unknown option: -b%s\n", AcpiGbl_Optarg);
240 switch (AcpiGbl_Optarg[0])
244 Gbl_NoResourceChecking = TRUE;
249 printf ("Unknown option: -c%s\n", AcpiGbl_Optarg);
254 case 'd': /* Disassembler */
256 switch (AcpiGbl_Optarg[0])
260 Gbl_DoCompile = FALSE;
265 Gbl_DoCompile = FALSE;
266 Gbl_DisassembleAll = TRUE;
269 case 'b': /* Do not convert buffers to resource descriptors */
271 AcpiGbl_NoResourceDisassembly = TRUE;
280 AcpiGbl_ForceAmlDisassembly = TRUE;
283 case 'l': /* Use legacy ASL code (not ASL+) for disassembly */
285 Gbl_DoCompile = FALSE;
286 AcpiGbl_CstyleDisassembly = FALSE;
291 printf ("Unknown option: -d%s\n", AcpiGbl_Optarg);
295 Gbl_DisasmFlag = TRUE;
298 case 'D': /* Define a symbol */
300 PrAddDefine (AcpiGbl_Optarg, NULL, TRUE);
303 case 'e': /* External files for disassembler */
305 /* Get entire list of external files */
308 argv[AcpiGbl_Optind] = AcpiGbl_Optarg;
310 while (argv[AcpiGbl_Optind] &&
311 (argv[AcpiGbl_Optind][0] != '-'))
313 Status = AcpiDmAddToExternalFileList (argv[AcpiGbl_Optind]);
314 if (ACPI_FAILURE (Status))
316 printf ("Could not add %s to external list\n", argv[AcpiGbl_Optind]);
326 switch (AcpiGbl_Optarg[0])
328 case '^': /* Ignore errors and force creation of aml file */
330 Gbl_IgnoreErrors = TRUE;
333 case 'e': /* Disassembler: Get external declaration file */
335 if (AcpiGetoptArgument (argc, argv))
340 Gbl_ExternalRefFilename = AcpiGbl_Optarg;
345 printf ("Unknown option: -f%s\n", AcpiGbl_Optarg);
352 Gbl_CompileGeneric = TRUE;
355 case 'g': /* Get all ACPI tables */
357 printf ("-g option is deprecated, use acpidump utility instead\n");
362 switch (AcpiGbl_Optarg[0])
371 UtDisplayConstantOpcodes ();
383 ApDisplayReservedNames ();
388 UtDisplaySupportedTables ();
393 printf ("Unknown option: -h%s\n", AcpiGbl_Optarg);
397 case 'I': /* Add an include file search directory */
399 FlAddIncludeDirectory (AcpiGbl_Optarg);
402 case 'i': /* Output AML as an include file */
404 switch (AcpiGbl_Optarg[0])
408 /* Produce assembly code include file */
410 Gbl_AsmIncludeOutputFlag = TRUE;
415 /* Produce C include file */
417 Gbl_C_IncludeOutputFlag = TRUE;
422 /* Compiler/Disassembler: Ignore the NOOP operator */
424 AcpiGbl_IgnoreNoopOperator = TRUE;
429 printf ("Unknown option: -i%s\n", AcpiGbl_Optarg);
434 case 'l': /* Listing files */
436 switch (AcpiGbl_Optarg[0])
440 /* Produce listing file (Mixed source/aml) */
442 Gbl_ListingFlag = TRUE;
447 /* Produce preprocessor output file */
449 Gbl_PreprocessorOutputFlag = TRUE;
454 /* Produce hardware map summary file */
456 Gbl_MapfileFlag = TRUE;
461 /* Produce namespace file */
463 Gbl_NsOutputFlag = TRUE;
468 /* Produce combined source file */
470 Gbl_SourceOutputFlag = TRUE;
475 printf ("Unknown option: -l%s\n", AcpiGbl_Optarg);
480 case 'm': /* Set line buffer size */
482 Gbl_LineBufferSize = (UINT32) strtoul (AcpiGbl_Optarg, NULL, 0) * 1024;
483 if (Gbl_LineBufferSize < ASL_DEFAULT_LINE_BUFFER_SIZE)
485 Gbl_LineBufferSize = ASL_DEFAULT_LINE_BUFFER_SIZE;
487 printf ("Line Buffer Size: %u\n", Gbl_LineBufferSize);
490 case 'n': /* Parse only */
492 Gbl_ParseOnlyFlag = TRUE;
495 case 'o': /* Control compiler AML optimizations */
497 switch (AcpiGbl_Optarg[0])
501 /* Disable all optimizations */
503 Gbl_FoldConstants = FALSE;
504 Gbl_IntegerOptimizationFlag = FALSE;
505 Gbl_ReferenceOptimizationFlag = FALSE;
510 /* Disable folding on "normal" expressions */
512 Gbl_FoldConstants = FALSE;
517 /* Disable integer optimization to constants */
519 Gbl_IntegerOptimizationFlag = FALSE;
524 /* Disable named reference optimization */
526 Gbl_ReferenceOptimizationFlag = FALSE;
531 /* Display compile time(s) */
533 Gbl_CompileTimesFlag = TRUE;
538 printf ("Unknown option: -c%s\n", AcpiGbl_Optarg);
543 case 'P': /* Preprocessor options */
545 switch (AcpiGbl_Optarg[0])
547 case '^': /* Proprocess only, emit (.i) file */
549 Gbl_PreprocessOnly = TRUE;
550 Gbl_PreprocessorOutputFlag = TRUE;
553 case 'n': /* Disable preprocessor */
555 Gbl_PreprocessFlag = FALSE;
560 printf ("Unknown option: -P%s\n", AcpiGbl_Optarg);
565 case 'p': /* Override default AML output filename */
567 Gbl_OutputFilenamePrefix = AcpiGbl_Optarg;
568 UtConvertBackslashes (Gbl_OutputFilenamePrefix);
569 Gbl_UseDefaultAmlFilename = FALSE;
572 case 'r': /* Override revision found in table header */
574 Gbl_RevisionOverride = (UINT8) strtoul (AcpiGbl_Optarg, NULL, 0);
577 case 's': /* Create AML in a source code file */
579 switch (AcpiGbl_Optarg[0])
583 /* Produce assembly code output file */
585 Gbl_AsmOutputFlag = TRUE;
590 /* Produce C hex output file */
592 Gbl_C_OutputFlag = TRUE;
597 /* Produce AML offset table in C */
599 Gbl_C_OffsetTableFlag = TRUE;
604 printf ("Unknown option: -s%s\n", AcpiGbl_Optarg);
609 case 't': /* Produce hex table output file */
611 switch (AcpiGbl_Optarg[0])
615 Gbl_HexOutputFlag = HEX_OUTPUT_ASM;
620 Gbl_HexOutputFlag = HEX_OUTPUT_C;
625 Gbl_HexOutputFlag = HEX_OUTPUT_ASL;
630 printf ("Unknown option: -t%s\n", AcpiGbl_Optarg);
635 case 'T': /* Create a ACPI table template file */
637 Gbl_DoTemplates = TRUE;
638 Gbl_TemplateSignature = AcpiGbl_Optarg;
641 case 'v': /* Version and verbosity settings */
643 switch (AcpiGbl_Optarg[0])
647 printf (ACPI_COMMON_SIGNON (ASL_COMPILER_NAME));
652 /* Disable all error/warning/remark messages */
659 /* Disable all warning/remark messages (errors only) */
661 Gbl_DisplayRemarks = FALSE;
662 Gbl_DisplayWarnings = FALSE;
667 * Support for integrated development environment(s).
669 * 1) No compiler signon
670 * 2) Send stderr messages to stdout
671 * 3) Less verbose error messages (single line only for each)
672 * 4) Error/warning messages are formatted appropriately to
673 * be recognized by MS Visual Studio
675 Gbl_VerboseErrors = FALSE;
676 Gbl_DoSignon = FALSE;
677 Gbl_Files[ASL_FILE_STDERR].Handle = stdout;
682 Gbl_DisplayOptimizations = TRUE;
687 Gbl_DisplayRemarks = FALSE;
692 Gbl_DoSignon = FALSE;
697 Gbl_VerboseTemplates = TRUE;
702 /* Get the required argument */
704 if (AcpiGetoptArgument (argc, argv))
709 Status = AslDisableException (AcpiGbl_Optarg);
710 if (ACPI_FAILURE (Status))
718 printf ("Unknown option: -v%s\n", AcpiGbl_Optarg);
723 case 'w': /* Set warning levels */
725 switch (AcpiGbl_Optarg[0])
729 Gbl_WarningLevel = ASL_WARNING;
734 Gbl_WarningLevel = ASL_WARNING2;
739 Gbl_WarningLevel = ASL_WARNING3;
744 Gbl_WarningsAsErrors = TRUE;
749 printf ("Unknown option: -w%s\n", AcpiGbl_Optarg);
754 case 'x': /* Set debug print output level */
756 AcpiDbgLevel = strtoul (AcpiGbl_Optarg, NULL, 16);
761 Gbl_UseOriginalCompilerId = TRUE;
773 /*******************************************************************************
775 * FUNCTION: AslMergeOptionTokens
777 * PARAMETERS: InBuffer - Input containing an option string
778 * OutBuffer - Merged output buffer
782 * DESCRIPTION: Remove all whitespace from an option string.
784 ******************************************************************************/
787 AslMergeOptionTokens (
796 Token = strtok (InBuffer, ASL_TOKEN_SEPARATORS);
799 strcat (OutBuffer, Token);
800 Token = strtok (NULL, ASL_TOKEN_SEPARATORS);
805 /*******************************************************************************
807 * FUNCTION: AslDoResponseFile
809 * PARAMETERS: Filename - Name of the response file
813 * DESCRIPTION: Open a response file and process all options within.
815 ******************************************************************************/
821 char *argv = StringBuffer2;
828 ResponseFile = fopen (Filename, "r");
831 printf ("Could not open command file %s, %s\n",
832 Filename, strerror (errno));
836 /* Must save the current GetOpt globals */
838 Opterr = AcpiGbl_Opterr;
839 Optind = AcpiGbl_Optind;
842 * Process all lines in the response file. There must be one complete
845 while (fgets (StringBuffer, ASL_MSG_BUFFER_SIZE, ResponseFile))
847 /* Compress all tokens, allowing us to use a single argv entry */
849 AslMergeOptionTokens (StringBuffer, StringBuffer2);
851 /* Process the option */
856 OptStatus = AslDoOptions (1, &argv, TRUE);
859 printf ("Invalid option in command file %s: %s\n",
860 Filename, StringBuffer);
865 /* Restore the GetOpt globals */
867 AcpiGbl_Opterr = Opterr;
868 AcpiGbl_Optind = Optind;
870 fclose (ResponseFile);