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"
73 static char ASL_BUILD_DATE[] = __DATE__;
74 static char ASL_BUILD_TIME[] = __TIME__;
77 /*******************************************************************************
79 * FUNCTION: AslCommandLine
81 * PARAMETERS: argc/argv
83 * RETURN: Last argv index
85 * DESCRIPTION: Command line processing
87 ******************************************************************************/
94 int BadCommandLine = 0;
98 /* Minimum command line contains at least the command and an input file */
102 printf (ACPI_COMMON_SIGNON (ASL_COMPILER_NAME));
107 /* Process all command line options */
109 BadCommandLine = AslDoOptions (argc, argv, FALSE);
113 Status = DtCreateTemplates (argv);
114 if (ACPI_FAILURE (Status))
121 /* Next parameter must be the input filename */
123 if (!argv[AcpiGbl_Optind] &&
126 printf ("Missing input filename\n");
127 BadCommandLine = TRUE;
132 printf (ACPI_COMMON_SIGNON (ASL_COMPILER_NAME));
133 if (Gbl_IgnoreErrors)
135 printf ("Ignoring all errors, forcing AML file generation\n\n");
141 printf ("Use -h option for help information\n");
145 return (AcpiGbl_Optind);
149 /*******************************************************************************
151 * FUNCTION: AslDoOptions
153 * PARAMETERS: argc/argv - Standard argc/argv
154 * IsResponseFile - TRUE if executing a response file.
158 * DESCRIPTION: Command line option processing
160 ******************************************************************************/
166 BOOLEAN IsResponseFile)
172 /* Get the command line options */
174 while ((j = AcpiGetopt (argc, argv, ASL_SUPPORTED_OPTIONS)) != ACPI_OPT_END) switch (j)
176 case '@': /* Begin a response file */
180 printf ("Nested command files are not supported\n");
184 if (AslDoResponseFile (AcpiGbl_Optarg))
190 case 'a': /* Debug options */
192 switch (AcpiGbl_Optarg[0])
196 Gbl_EnableReferenceTypechecking = TRUE;
201 printf ("Unknown option: -a%s\n", AcpiGbl_Optarg);
208 case 'b': /* Debug options */
210 switch (AcpiGbl_Optarg[0])
214 AslCompilerdebug = 1; /* same as yydebug */
217 Gbl_DebugFlag = TRUE;
218 Gbl_KeepPreprocessorTempFile = TRUE;
221 case 'p': /* Prune ASL parse tree */
223 /* Get the required argument */
225 if (AcpiGetoptArgument (argc, argv))
230 Gbl_PruneParseTree = TRUE;
231 Gbl_PruneDepth = (UINT8) strtoul (AcpiGbl_Optarg, NULL, 0);
236 Gbl_DebugFlag = TRUE;
241 /* Get the required argument */
243 if (AcpiGetoptArgument (argc, argv))
248 Gbl_PruneType = (UINT8) strtoul (AcpiGbl_Optarg, NULL, 0);
253 printf ("Unknown option: -b%s\n", AcpiGbl_Optarg);
261 switch (AcpiGbl_Optarg[0])
265 Gbl_NoResourceChecking = TRUE;
270 printf ("Unknown option: -c%s\n", AcpiGbl_Optarg);
275 case 'd': /* Disassembler */
277 switch (AcpiGbl_Optarg[0])
281 /* Get the required argument */
283 if (AcpiGetoptArgument (argc, argv))
288 Gbl_DoCompile = FALSE;
293 /* Get the required argument */
295 if (AcpiGetoptArgument (argc, argv))
300 Gbl_DoCompile = FALSE;
301 Gbl_DisassembleAll = TRUE;
304 case 'b': /* Do not convert buffers to resource descriptors */
306 AcpiGbl_NoResourceDisassembly = TRUE;
315 AcpiGbl_ForceAmlDisassembly = TRUE;
318 case 'l': /* Use legacy ASL code (not ASL+) for disassembly */
320 Gbl_DoCompile = FALSE;
321 AcpiGbl_CstyleDisassembly = FALSE;
326 printf ("Unknown option: -d%s\n", AcpiGbl_Optarg);
330 Gbl_DisasmFlag = TRUE;
333 case 'D': /* Define a symbol */
335 PrAddDefine (AcpiGbl_Optarg, NULL, TRUE);
338 case 'e': /* External files for disassembler */
340 /* Get entire list of external files */
343 argv[AcpiGbl_Optind] = AcpiGbl_Optarg;
345 while (argv[AcpiGbl_Optind] &&
346 (argv[AcpiGbl_Optind][0] != '-'))
348 Status = AcpiDmAddToExternalFileList (argv[AcpiGbl_Optind]);
349 if (ACPI_FAILURE (Status))
351 printf ("Could not add %s to external list\n",
352 argv[AcpiGbl_Optind]);
362 switch (AcpiGbl_Optarg[0])
364 case '^': /* Ignore errors and force creation of aml file */
366 Gbl_IgnoreErrors = TRUE;
369 case 'e': /* Disassembler: Get external declaration file */
371 if (AcpiGetoptArgument (argc, argv))
376 Gbl_ExternalRefFilename = AcpiGbl_Optarg;
381 printf ("Unknown option: -f%s\n", AcpiGbl_Optarg);
388 Gbl_CompileGeneric = TRUE;
391 case 'g': /* Get all ACPI tables */
393 printf ("-g option is deprecated, use acpidump utility instead\n");
398 switch (AcpiGbl_Optarg[0])
407 UtDisplayConstantOpcodes ();
412 AslDisassemblyHelp ();
424 ApDisplayReservedNames ();
429 UtDisplaySupportedTables ();
434 printf ("Unknown option: -h%s\n", AcpiGbl_Optarg);
438 case 'I': /* Add an include file search directory */
440 FlAddIncludeDirectory (AcpiGbl_Optarg);
443 case 'i': /* Output AML as an include file */
445 switch (AcpiGbl_Optarg[0])
449 /* Produce assembly code include file */
451 Gbl_AsmIncludeOutputFlag = TRUE;
456 /* Produce C include file */
458 Gbl_C_IncludeOutputFlag = TRUE;
463 /* Compiler/Disassembler: Ignore the NOOP operator */
465 AcpiGbl_IgnoreNoopOperator = TRUE;
470 printf ("Unknown option: -i%s\n", AcpiGbl_Optarg);
475 case 'l': /* Listing files */
477 switch (AcpiGbl_Optarg[0])
481 /* Produce listing file (Mixed source/aml) */
483 Gbl_ListingFlag = TRUE;
484 AcpiGbl_DmOpt_Listing = TRUE;
489 /* Produce preprocessor output file */
491 Gbl_PreprocessorOutputFlag = TRUE;
496 /* Produce hardware map summary file */
498 Gbl_MapfileFlag = TRUE;
503 /* Produce namespace file */
505 Gbl_NsOutputFlag = TRUE;
510 /* Produce combined source file */
512 Gbl_SourceOutputFlag = TRUE;
517 /* Produce cross-reference file */
519 Gbl_CrossReferenceOutput = TRUE;
524 printf ("Unknown option: -l%s\n", AcpiGbl_Optarg);
529 case 'm': /* Set line buffer size */
531 Gbl_LineBufferSize = (UINT32) strtoul (AcpiGbl_Optarg, NULL, 0) * 1024;
532 if (Gbl_LineBufferSize < ASL_DEFAULT_LINE_BUFFER_SIZE)
534 Gbl_LineBufferSize = ASL_DEFAULT_LINE_BUFFER_SIZE;
536 printf ("Line Buffer Size: %u\n", Gbl_LineBufferSize);
539 case 'n': /* Parse only */
541 Gbl_ParseOnlyFlag = TRUE;
544 case 'o': /* Control compiler AML optimizations */
546 switch (AcpiGbl_Optarg[0])
550 /* Disable all optimizations */
552 Gbl_FoldConstants = FALSE;
553 Gbl_IntegerOptimizationFlag = FALSE;
554 Gbl_ReferenceOptimizationFlag = FALSE;
559 /* Display compile time(s) */
561 Gbl_CompileTimesFlag = TRUE;
566 /* Disable disassembler code optimizations */
568 AcpiGbl_DoDisassemblerOptimizations = FALSE;
573 /* iASL: Disable External opcode generation */
575 Gbl_DoExternals = FALSE;
577 /* Disassembler: Emit embedded external operators */
579 AcpiGbl_DmEmitExternalOpcodes = TRUE;
584 /* Disable folding on "normal" expressions */
586 Gbl_FoldConstants = FALSE;
591 /* Disable integer optimization to constants */
593 Gbl_IntegerOptimizationFlag = FALSE;
598 /* Disable named reference optimization */
600 Gbl_ReferenceOptimizationFlag = FALSE;
605 /* Disable heavy typechecking */
607 Gbl_DoTypechecking = FALSE;
612 printf ("Unknown option: -c%s\n", AcpiGbl_Optarg);
617 case 'P': /* Preprocessor options */
619 switch (AcpiGbl_Optarg[0])
621 case '^': /* Proprocess only, emit (.i) file */
623 Gbl_PreprocessOnly = TRUE;
624 Gbl_PreprocessorOutputFlag = TRUE;
627 case 'n': /* Disable preprocessor */
629 Gbl_PreprocessFlag = FALSE;
634 printf ("Unknown option: -P%s\n", AcpiGbl_Optarg);
639 case 'p': /* Override default AML output filename */
641 Gbl_OutputFilenamePrefix = AcpiGbl_Optarg;
642 UtConvertBackslashes (Gbl_OutputFilenamePrefix);
643 Gbl_UseDefaultAmlFilename = FALSE;
646 case 'r': /* Override revision found in table header */
648 Gbl_RevisionOverride = (UINT8) strtoul (AcpiGbl_Optarg, NULL, 0);
651 case 's': /* Create AML in a source code file */
653 switch (AcpiGbl_Optarg[0])
657 /* Produce assembly code output file */
659 Gbl_AsmOutputFlag = TRUE;
664 /* Produce C hex output file */
666 Gbl_C_OutputFlag = TRUE;
671 /* Produce AML offset table in C */
673 Gbl_C_OffsetTableFlag = TRUE;
678 printf ("Unknown option: -s%s\n", AcpiGbl_Optarg);
683 case 't': /* Produce hex table output file */
685 switch (AcpiGbl_Optarg[0])
689 Gbl_HexOutputFlag = HEX_OUTPUT_ASM;
694 Gbl_HexOutputFlag = HEX_OUTPUT_C;
699 Gbl_HexOutputFlag = HEX_OUTPUT_ASL;
704 printf ("Unknown option: -t%s\n", AcpiGbl_Optarg);
709 case 'T': /* Create a ACPI table template file */
711 Gbl_DoTemplates = TRUE;
714 case 'v': /* Version and verbosity settings */
716 switch (AcpiGbl_Optarg[0])
720 printf (ACPI_COMMON_SIGNON (ASL_COMPILER_NAME));
725 /* Disable all error/warning/remark messages */
732 printf ("%s Build date/time: %s %s\n",
733 ASL_COMPILER_NAME, ASL_BUILD_DATE, ASL_BUILD_TIME);
738 /* Disable all warning/remark messages (errors only) */
740 Gbl_DisplayRemarks = FALSE;
741 Gbl_DisplayWarnings = FALSE;
746 * Support for integrated development environment(s).
748 * 1) No compiler signon
749 * 2) Send stderr messages to stdout
750 * 3) Less verbose error messages (single line only for each)
751 * 4) Error/warning messages are formatted appropriately to
752 * be recognized by MS Visual Studio
754 Gbl_VerboseErrors = FALSE;
755 Gbl_DoSignon = FALSE;
756 Gbl_Files[ASL_FILE_STDERR].Handle = stdout;
761 Gbl_DisplayOptimizations = TRUE;
766 Gbl_DisplayRemarks = FALSE;
771 Gbl_DoSignon = FALSE;
776 Gbl_VerboseTemplates = TRUE;
781 /* Get the required argument */
783 if (AcpiGetoptArgument (argc, argv))
788 Status = AslDisableException (AcpiGbl_Optarg);
789 if (ACPI_FAILURE (Status))
797 printf ("Unknown option: -v%s\n", AcpiGbl_Optarg);
802 case 'w': /* Set warning levels */
804 switch (AcpiGbl_Optarg[0])
808 Gbl_WarningLevel = ASL_WARNING;
813 Gbl_WarningLevel = ASL_WARNING2;
818 Gbl_WarningLevel = ASL_WARNING3;
823 Gbl_WarningsAsErrors = TRUE;
828 printf ("Unknown option: -w%s\n", AcpiGbl_Optarg);
833 case 'x': /* Set debug print output level */
835 AcpiDbgLevel = strtoul (AcpiGbl_Optarg, NULL, 16);
840 Gbl_UseOriginalCompilerId = TRUE;
852 /*******************************************************************************
854 * FUNCTION: AslMergeOptionTokens
856 * PARAMETERS: InBuffer - Input containing an option string
857 * OutBuffer - Merged output buffer
861 * DESCRIPTION: Remove all whitespace from an option string.
863 ******************************************************************************/
866 AslMergeOptionTokens (
875 Token = strtok (InBuffer, ASL_TOKEN_SEPARATORS);
878 strcat (OutBuffer, Token);
879 Token = strtok (NULL, ASL_TOKEN_SEPARATORS);
884 /*******************************************************************************
886 * FUNCTION: AslDoResponseFile
888 * PARAMETERS: Filename - Name of the response file
892 * DESCRIPTION: Open a response file and process all options within.
894 ******************************************************************************/
900 char *argv = StringBuffer2;
907 ResponseFile = fopen (Filename, "r");
910 printf ("Could not open command file %s, %s\n",
911 Filename, strerror (errno));
915 /* Must save the current GetOpt globals */
917 Opterr = AcpiGbl_Opterr;
918 Optind = AcpiGbl_Optind;
921 * Process all lines in the response file. There must be one complete
924 while (fgets (StringBuffer, ASL_MSG_BUFFER_SIZE, ResponseFile))
926 /* Compress all tokens, allowing us to use a single argv entry */
928 AslMergeOptionTokens (StringBuffer, StringBuffer2);
930 /* Process the option */
935 OptStatus = AslDoOptions (1, &argv, TRUE);
938 printf ("Invalid option in command file %s: %s\n",
939 Filename, StringBuffer);
944 /* Restore the GetOpt globals */
946 AcpiGbl_Opterr = Opterr;
947 AcpiGbl_Optind = Optind;
949 fclose (ResponseFile);