1 /******************************************************************************
3 * Module Name: asloptions - compiler command line processing
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2016, 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 "@:a: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 (argv);
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 'a': /* Debug options */
189 switch (AcpiGbl_Optarg[0])
193 Gbl_EnableReferenceTypechecking = TRUE;
198 printf ("Unknown option: -a%s\n", AcpiGbl_Optarg);
205 case 'b': /* Debug options */
207 switch (AcpiGbl_Optarg[0])
211 AslCompilerdebug = 1; /* same as yydebug */
214 Gbl_DebugFlag = TRUE;
215 Gbl_KeepPreprocessorTempFile = TRUE;
218 case 'p': /* Prune ASL parse tree */
220 /* Get the required argument */
222 if (AcpiGetoptArgument (argc, argv))
227 Gbl_PruneParseTree = TRUE;
228 Gbl_PruneDepth = (UINT8) strtoul (AcpiGbl_Optarg, NULL, 0);
233 Gbl_DebugFlag = TRUE;
238 /* Get the required argument */
240 if (AcpiGetoptArgument (argc, argv))
245 Gbl_PruneType = (UINT8) strtoul (AcpiGbl_Optarg, NULL, 0);
250 printf ("Unknown option: -b%s\n", AcpiGbl_Optarg);
258 switch (AcpiGbl_Optarg[0])
262 Gbl_NoResourceChecking = TRUE;
267 printf ("Unknown option: -c%s\n", AcpiGbl_Optarg);
272 case 'd': /* Disassembler */
274 switch (AcpiGbl_Optarg[0])
278 Gbl_DoCompile = FALSE;
283 Gbl_DoCompile = FALSE;
284 Gbl_DisassembleAll = TRUE;
287 case 'b': /* Do not convert buffers to resource descriptors */
289 AcpiGbl_NoResourceDisassembly = TRUE;
298 AcpiGbl_ForceAmlDisassembly = TRUE;
301 case 'l': /* Use legacy ASL code (not ASL+) for disassembly */
303 Gbl_DoCompile = FALSE;
304 AcpiGbl_CstyleDisassembly = FALSE;
309 printf ("Unknown option: -d%s\n", AcpiGbl_Optarg);
313 Gbl_DisasmFlag = TRUE;
316 case 'D': /* Define a symbol */
318 PrAddDefine (AcpiGbl_Optarg, NULL, TRUE);
321 case 'e': /* External files for disassembler */
323 /* Get entire list of external files */
326 argv[AcpiGbl_Optind] = AcpiGbl_Optarg;
328 while (argv[AcpiGbl_Optind] &&
329 (argv[AcpiGbl_Optind][0] != '-'))
331 Status = AcpiDmAddToExternalFileList (argv[AcpiGbl_Optind]);
332 if (ACPI_FAILURE (Status))
334 printf ("Could not add %s to external list\n",
335 argv[AcpiGbl_Optind]);
345 switch (AcpiGbl_Optarg[0])
347 case '^': /* Ignore errors and force creation of aml file */
349 Gbl_IgnoreErrors = TRUE;
352 case 'e': /* Disassembler: Get external declaration file */
354 if (AcpiGetoptArgument (argc, argv))
359 Gbl_ExternalRefFilename = AcpiGbl_Optarg;
364 printf ("Unknown option: -f%s\n", AcpiGbl_Optarg);
371 Gbl_CompileGeneric = TRUE;
374 case 'g': /* Get all ACPI tables */
376 printf ("-g option is deprecated, use acpidump utility instead\n");
381 switch (AcpiGbl_Optarg[0])
390 UtDisplayConstantOpcodes ();
402 ApDisplayReservedNames ();
407 UtDisplaySupportedTables ();
412 printf ("Unknown option: -h%s\n", AcpiGbl_Optarg);
416 case 'I': /* Add an include file search directory */
418 FlAddIncludeDirectory (AcpiGbl_Optarg);
421 case 'i': /* Output AML as an include file */
423 switch (AcpiGbl_Optarg[0])
427 /* Produce assembly code include file */
429 Gbl_AsmIncludeOutputFlag = TRUE;
434 /* Produce C include file */
436 Gbl_C_IncludeOutputFlag = TRUE;
441 /* Compiler/Disassembler: Ignore the NOOP operator */
443 AcpiGbl_IgnoreNoopOperator = TRUE;
448 printf ("Unknown option: -i%s\n", AcpiGbl_Optarg);
453 case 'l': /* Listing files */
455 switch (AcpiGbl_Optarg[0])
459 /* Produce listing file (Mixed source/aml) */
461 Gbl_ListingFlag = TRUE;
462 AcpiGbl_DmOpt_Listing = TRUE;
467 /* Produce preprocessor output file */
469 Gbl_PreprocessorOutputFlag = TRUE;
474 /* Produce hardware map summary file */
476 Gbl_MapfileFlag = TRUE;
481 /* Produce namespace file */
483 Gbl_NsOutputFlag = TRUE;
488 /* Produce combined source file */
490 Gbl_SourceOutputFlag = TRUE;
495 /* Produce cross-reference file */
497 Gbl_CrossReferenceOutput = TRUE;
502 printf ("Unknown option: -l%s\n", AcpiGbl_Optarg);
507 case 'm': /* Set line buffer size */
509 Gbl_LineBufferSize = (UINT32) strtoul (AcpiGbl_Optarg, NULL, 0) * 1024;
510 if (Gbl_LineBufferSize < ASL_DEFAULT_LINE_BUFFER_SIZE)
512 Gbl_LineBufferSize = ASL_DEFAULT_LINE_BUFFER_SIZE;
514 printf ("Line Buffer Size: %u\n", Gbl_LineBufferSize);
517 case 'n': /* Parse only */
519 Gbl_ParseOnlyFlag = TRUE;
522 case 'o': /* Control compiler AML optimizations */
524 switch (AcpiGbl_Optarg[0])
528 /* Disable all optimizations */
530 Gbl_FoldConstants = FALSE;
531 Gbl_IntegerOptimizationFlag = FALSE;
532 Gbl_ReferenceOptimizationFlag = FALSE;
537 /* Display compile time(s) */
539 Gbl_CompileTimesFlag = TRUE;
544 /* iASL: Disable External opcode generation */
546 Gbl_DoExternals = FALSE;
548 /* Disassembler: Emit embedded external operators */
550 AcpiGbl_DmEmitExternalOpcodes = TRUE;
555 /* Disable folding on "normal" expressions */
557 Gbl_FoldConstants = FALSE;
562 /* Disable integer optimization to constants */
564 Gbl_IntegerOptimizationFlag = FALSE;
569 /* Disable named reference optimization */
571 Gbl_ReferenceOptimizationFlag = FALSE;
576 /* Disable heavy typechecking */
578 Gbl_DoTypechecking = FALSE;
583 printf ("Unknown option: -c%s\n", AcpiGbl_Optarg);
588 case 'P': /* Preprocessor options */
590 switch (AcpiGbl_Optarg[0])
592 case '^': /* Proprocess only, emit (.i) file */
594 Gbl_PreprocessOnly = TRUE;
595 Gbl_PreprocessorOutputFlag = TRUE;
598 case 'n': /* Disable preprocessor */
600 Gbl_PreprocessFlag = FALSE;
605 printf ("Unknown option: -P%s\n", AcpiGbl_Optarg);
610 case 'p': /* Override default AML output filename */
612 Gbl_OutputFilenamePrefix = AcpiGbl_Optarg;
613 UtConvertBackslashes (Gbl_OutputFilenamePrefix);
614 Gbl_UseDefaultAmlFilename = FALSE;
617 case 'r': /* Override revision found in table header */
619 Gbl_RevisionOverride = (UINT8) strtoul (AcpiGbl_Optarg, NULL, 0);
622 case 's': /* Create AML in a source code file */
624 switch (AcpiGbl_Optarg[0])
628 /* Produce assembly code output file */
630 Gbl_AsmOutputFlag = TRUE;
635 /* Produce C hex output file */
637 Gbl_C_OutputFlag = TRUE;
642 /* Produce AML offset table in C */
644 Gbl_C_OffsetTableFlag = TRUE;
649 printf ("Unknown option: -s%s\n", AcpiGbl_Optarg);
654 case 't': /* Produce hex table output file */
656 switch (AcpiGbl_Optarg[0])
660 Gbl_HexOutputFlag = HEX_OUTPUT_ASM;
665 Gbl_HexOutputFlag = HEX_OUTPUT_C;
670 Gbl_HexOutputFlag = HEX_OUTPUT_ASL;
675 printf ("Unknown option: -t%s\n", AcpiGbl_Optarg);
680 case 'T': /* Create a ACPI table template file */
682 Gbl_DoTemplates = TRUE;
685 case 'v': /* Version and verbosity settings */
687 switch (AcpiGbl_Optarg[0])
691 printf (ACPI_COMMON_SIGNON (ASL_COMPILER_NAME));
696 /* Disable all error/warning/remark messages */
703 /* Disable all warning/remark messages (errors only) */
705 Gbl_DisplayRemarks = FALSE;
706 Gbl_DisplayWarnings = FALSE;
711 * Support for integrated development environment(s).
713 * 1) No compiler signon
714 * 2) Send stderr messages to stdout
715 * 3) Less verbose error messages (single line only for each)
716 * 4) Error/warning messages are formatted appropriately to
717 * be recognized by MS Visual Studio
719 Gbl_VerboseErrors = FALSE;
720 Gbl_DoSignon = FALSE;
721 Gbl_Files[ASL_FILE_STDERR].Handle = stdout;
726 Gbl_DisplayOptimizations = TRUE;
731 Gbl_DisplayRemarks = FALSE;
736 Gbl_DoSignon = FALSE;
741 Gbl_VerboseTemplates = TRUE;
746 /* Get the required argument */
748 if (AcpiGetoptArgument (argc, argv))
753 Status = AslDisableException (AcpiGbl_Optarg);
754 if (ACPI_FAILURE (Status))
762 printf ("Unknown option: -v%s\n", AcpiGbl_Optarg);
767 case 'w': /* Set warning levels */
769 switch (AcpiGbl_Optarg[0])
773 Gbl_WarningLevel = ASL_WARNING;
778 Gbl_WarningLevel = ASL_WARNING2;
783 Gbl_WarningLevel = ASL_WARNING3;
788 Gbl_WarningsAsErrors = TRUE;
793 printf ("Unknown option: -w%s\n", AcpiGbl_Optarg);
798 case 'x': /* Set debug print output level */
800 AcpiDbgLevel = strtoul (AcpiGbl_Optarg, NULL, 16);
805 Gbl_UseOriginalCompilerId = TRUE;
817 /*******************************************************************************
819 * FUNCTION: AslMergeOptionTokens
821 * PARAMETERS: InBuffer - Input containing an option string
822 * OutBuffer - Merged output buffer
826 * DESCRIPTION: Remove all whitespace from an option string.
828 ******************************************************************************/
831 AslMergeOptionTokens (
840 Token = strtok (InBuffer, ASL_TOKEN_SEPARATORS);
843 strcat (OutBuffer, Token);
844 Token = strtok (NULL, ASL_TOKEN_SEPARATORS);
849 /*******************************************************************************
851 * FUNCTION: AslDoResponseFile
853 * PARAMETERS: Filename - Name of the response file
857 * DESCRIPTION: Open a response file and process all options within.
859 ******************************************************************************/
865 char *argv = StringBuffer2;
872 ResponseFile = fopen (Filename, "r");
875 printf ("Could not open command file %s, %s\n",
876 Filename, strerror (errno));
880 /* Must save the current GetOpt globals */
882 Opterr = AcpiGbl_Opterr;
883 Optind = AcpiGbl_Optind;
886 * Process all lines in the response file. There must be one complete
889 while (fgets (StringBuffer, ASL_MSG_BUFFER_SIZE, ResponseFile))
891 /* Compress all tokens, allowing us to use a single argv entry */
893 AslMergeOptionTokens (StringBuffer, StringBuffer2);
895 /* Process the option */
900 OptStatus = AslDoOptions (1, &argv, TRUE);
903 printf ("Invalid option in command file %s: %s\n",
904 Filename, StringBuffer);
909 /* Restore the GetOpt globals */
911 AcpiGbl_Opterr = Opterr;
912 AcpiGbl_Optind = Optind;
914 fclose (ResponseFile);