Sync ACPICA with Intel's version 20160831.
[dragonfly.git] / sys / contrib / dev / acpica / source / compiler / asloptions.c
blobb9d4e3c407020cf5005624490d92fced4a5f41b5
1 /******************************************************************************
3 * Module Name: asloptions - compiler command line processing
5 *****************************************************************************/
7 /*
8 * Copyright (C) 2000 - 2016, Intel Corp.
9 * All rights reserved.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
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.
30 * NO WARRANTY
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 "aslcompiler.h"
45 #include "acapps.h"
46 #include "acdisasm.h"
48 #define _COMPONENT ACPI_COMPILER
49 ACPI_MODULE_NAME ("asloption")
52 /* Local prototypes */
54 static int
55 AslDoOptions (
56 int argc,
57 char **argv,
58 BOOLEAN IsResponseFile);
60 static void
61 AslMergeOptionTokens (
62 char *InBuffer,
63 char *OutBuffer);
65 static int
66 AslDoResponseFile (
67 char *Filename);
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 ******************************************************************************/
89 int
90 AslCommandLine (
91 int argc,
92 char **argv)
94 int BadCommandLine = 0;
95 ACPI_STATUS Status;
98 /* Minimum command line contains at least the command and an input file */
100 if (argc < 2)
102 printf (ACPI_COMMON_SIGNON (ASL_COMPILER_NAME));
103 Usage ();
104 exit (1);
107 /* Process all command line options */
109 BadCommandLine = AslDoOptions (argc, argv, FALSE);
111 if (Gbl_DoTemplates)
113 Status = DtCreateTemplates (argv);
114 if (ACPI_FAILURE (Status))
116 exit (-1);
118 exit (1);
121 /* Next parameter must be the input filename */
123 if (!argv[AcpiGbl_Optind] &&
124 !Gbl_DisasmFlag)
126 printf ("Missing input filename\n");
127 BadCommandLine = TRUE;
130 if (Gbl_DoSignon)
132 printf (ACPI_COMMON_SIGNON (ASL_COMPILER_NAME));
133 if (Gbl_IgnoreErrors)
135 printf ("Ignoring all errors, forcing AML file generation\n\n");
139 if (BadCommandLine)
141 printf ("Use -h option for help information\n");
142 exit (1);
145 return (AcpiGbl_Optind);
149 /*******************************************************************************
151 * FUNCTION: AslDoOptions
153 * PARAMETERS: argc/argv - Standard argc/argv
154 * IsResponseFile - TRUE if executing a response file.
156 * RETURN: Status
158 * DESCRIPTION: Command line option processing
160 ******************************************************************************/
162 static int
163 AslDoOptions (
164 int argc,
165 char **argv,
166 BOOLEAN IsResponseFile)
168 ACPI_STATUS Status;
169 UINT32 j;
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 */
178 if (IsResponseFile)
180 printf ("Nested command files are not supported\n");
181 return (-1);
184 if (AslDoResponseFile (AcpiGbl_Optarg))
186 return (-1);
188 break;
190 case 'a': /* Debug options */
192 switch (AcpiGbl_Optarg[0])
194 case 'r':
196 Gbl_EnableReferenceTypechecking = TRUE;
197 break;
199 default:
201 printf ("Unknown option: -a%s\n", AcpiGbl_Optarg);
202 return (-1);
205 break;
208 case 'b': /* Debug options */
210 switch (AcpiGbl_Optarg[0])
212 case 'f':
214 AslCompilerdebug = 1; /* same as yydebug */
215 DtParserdebug = 1;
216 PrParserdebug = 1;
217 Gbl_DebugFlag = TRUE;
218 Gbl_KeepPreprocessorTempFile = TRUE;
219 break;
221 case 'p': /* Prune ASL parse tree */
223 /* Get the required argument */
225 if (AcpiGetoptArgument (argc, argv))
227 return (-1);
230 Gbl_PruneParseTree = TRUE;
231 Gbl_PruneDepth = (UINT8) strtoul (AcpiGbl_Optarg, NULL, 0);
232 break;
234 case 's':
236 Gbl_DebugFlag = TRUE;
237 break;
239 case 't':
241 /* Get the required argument */
243 if (AcpiGetoptArgument (argc, argv))
245 return (-1);
248 Gbl_PruneType = (UINT8) strtoul (AcpiGbl_Optarg, NULL, 0);
249 break;
251 default:
253 printf ("Unknown option: -b%s\n", AcpiGbl_Optarg);
254 return (-1);
257 break;
259 case 'c':
261 switch (AcpiGbl_Optarg[0])
263 case 'r':
265 Gbl_NoResourceChecking = TRUE;
266 break;
268 default:
270 printf ("Unknown option: -c%s\n", AcpiGbl_Optarg);
271 return (-1);
273 break;
275 case 'd': /* Disassembler */
277 switch (AcpiGbl_Optarg[0])
279 case '^':
281 /* Get the required argument */
283 if (AcpiGetoptArgument (argc, argv))
285 return (-1);
288 Gbl_DoCompile = FALSE;
289 break;
291 case 'a':
293 /* Get the required argument */
295 if (AcpiGetoptArgument (argc, argv))
297 return (-1);
300 Gbl_DoCompile = FALSE;
301 Gbl_DisassembleAll = TRUE;
302 break;
304 case 'b': /* Do not convert buffers to resource descriptors */
306 AcpiGbl_NoResourceDisassembly = TRUE;
307 break;
309 case 'c':
311 break;
313 case 'f':
315 AcpiGbl_ForceAmlDisassembly = TRUE;
316 break;
318 case 'l': /* Use legacy ASL code (not ASL+) for disassembly */
320 Gbl_DoCompile = FALSE;
321 AcpiGbl_CstyleDisassembly = FALSE;
322 break;
324 default:
326 printf ("Unknown option: -d%s\n", AcpiGbl_Optarg);
327 return (-1);
330 Gbl_DisasmFlag = TRUE;
331 break;
333 case 'D': /* Define a symbol */
335 PrAddDefine (AcpiGbl_Optarg, NULL, TRUE);
336 break;
338 case 'e': /* External files for disassembler */
340 /* Get entire list of external files */
342 AcpiGbl_Optind--;
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]);
353 return (-1);
356 AcpiGbl_Optind++;
358 break;
360 case 'f':
362 switch (AcpiGbl_Optarg[0])
364 case '^': /* Ignore errors and force creation of aml file */
366 Gbl_IgnoreErrors = TRUE;
367 break;
369 case 'e': /* Disassembler: Get external declaration file */
371 if (AcpiGetoptArgument (argc, argv))
373 return (-1);
376 Gbl_ExternalRefFilename = AcpiGbl_Optarg;
377 break;
379 default:
381 printf ("Unknown option: -f%s\n", AcpiGbl_Optarg);
382 return (-1);
384 break;
386 case 'G':
388 Gbl_CompileGeneric = TRUE;
389 break;
391 case 'g': /* Get all ACPI tables */
393 printf ("-g option is deprecated, use acpidump utility instead\n");
394 exit (1);
396 case 'h':
398 switch (AcpiGbl_Optarg[0])
400 case '^':
402 Usage ();
403 exit (0);
405 case 'c':
407 UtDisplayConstantOpcodes ();
408 exit (0);
410 case 'd':
412 AslDisassemblyHelp ();
413 exit (0);
415 case 'f':
417 AslFilenameHelp ();
418 exit (0);
420 case 'r':
422 /* reserved names */
424 ApDisplayReservedNames ();
425 exit (0);
427 case 't':
429 UtDisplaySupportedTables ();
430 exit (0);
432 default:
434 printf ("Unknown option: -h%s\n", AcpiGbl_Optarg);
435 return (-1);
438 case 'I': /* Add an include file search directory */
440 FlAddIncludeDirectory (AcpiGbl_Optarg);
441 break;
443 case 'i': /* Output AML as an include file */
445 switch (AcpiGbl_Optarg[0])
447 case 'a':
449 /* Produce assembly code include file */
451 Gbl_AsmIncludeOutputFlag = TRUE;
452 break;
454 case 'c':
456 /* Produce C include file */
458 Gbl_C_IncludeOutputFlag = TRUE;
459 break;
461 case 'n':
463 /* Compiler/Disassembler: Ignore the NOOP operator */
465 AcpiGbl_IgnoreNoopOperator = TRUE;
466 break;
468 default:
470 printf ("Unknown option: -i%s\n", AcpiGbl_Optarg);
471 return (-1);
473 break;
475 case 'l': /* Listing files */
477 switch (AcpiGbl_Optarg[0])
479 case '^':
481 /* Produce listing file (Mixed source/aml) */
483 Gbl_ListingFlag = TRUE;
484 AcpiGbl_DmOpt_Listing = TRUE;
485 break;
487 case 'i':
489 /* Produce preprocessor output file */
491 Gbl_PreprocessorOutputFlag = TRUE;
492 break;
494 case 'm':
496 /* Produce hardware map summary file */
498 Gbl_MapfileFlag = TRUE;
499 break;
501 case 'n':
503 /* Produce namespace file */
505 Gbl_NsOutputFlag = TRUE;
506 break;
508 case 's':
510 /* Produce combined source file */
512 Gbl_SourceOutputFlag = TRUE;
513 break;
515 case 'x':
517 /* Produce cross-reference file */
519 Gbl_CrossReferenceOutput = TRUE;
520 break;
522 default:
524 printf ("Unknown option: -l%s\n", AcpiGbl_Optarg);
525 return (-1);
527 break;
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);
537 break;
539 case 'n': /* Parse only */
541 Gbl_ParseOnlyFlag = TRUE;
542 break;
544 case 'o': /* Control compiler AML optimizations */
546 switch (AcpiGbl_Optarg[0])
548 case 'a':
550 /* Disable all optimizations */
552 Gbl_FoldConstants = FALSE;
553 Gbl_IntegerOptimizationFlag = FALSE;
554 Gbl_ReferenceOptimizationFlag = FALSE;
555 break;
557 case 'c':
559 /* Display compile time(s) */
561 Gbl_CompileTimesFlag = TRUE;
562 break;
564 case 'e':
566 /* iASL: Disable External opcode generation */
568 Gbl_DoExternals = FALSE;
570 /* Disassembler: Emit embedded external operators */
572 AcpiGbl_DmEmitExternalOpcodes = TRUE;
573 break;
575 case 'f':
577 /* Disable folding on "normal" expressions */
579 Gbl_FoldConstants = FALSE;
580 break;
582 case 'i':
584 /* Disable integer optimization to constants */
586 Gbl_IntegerOptimizationFlag = FALSE;
587 break;
589 case 'n':
591 /* Disable named reference optimization */
593 Gbl_ReferenceOptimizationFlag = FALSE;
594 break;
596 case 't':
598 /* Disable heavy typechecking */
600 Gbl_DoTypechecking = FALSE;
601 break;
603 default:
605 printf ("Unknown option: -c%s\n", AcpiGbl_Optarg);
606 return (-1);
608 break;
610 case 'P': /* Preprocessor options */
612 switch (AcpiGbl_Optarg[0])
614 case '^': /* Proprocess only, emit (.i) file */
616 Gbl_PreprocessOnly = TRUE;
617 Gbl_PreprocessorOutputFlag = TRUE;
618 break;
620 case 'n': /* Disable preprocessor */
622 Gbl_PreprocessFlag = FALSE;
623 break;
625 default:
627 printf ("Unknown option: -P%s\n", AcpiGbl_Optarg);
628 return (-1);
630 break;
632 case 'p': /* Override default AML output filename */
634 Gbl_OutputFilenamePrefix = AcpiGbl_Optarg;
635 UtConvertBackslashes (Gbl_OutputFilenamePrefix);
636 Gbl_UseDefaultAmlFilename = FALSE;
637 break;
639 case 'r': /* Override revision found in table header */
641 Gbl_RevisionOverride = (UINT8) strtoul (AcpiGbl_Optarg, NULL, 0);
642 break;
644 case 's': /* Create AML in a source code file */
646 switch (AcpiGbl_Optarg[0])
648 case 'a':
650 /* Produce assembly code output file */
652 Gbl_AsmOutputFlag = TRUE;
653 break;
655 case 'c':
657 /* Produce C hex output file */
659 Gbl_C_OutputFlag = TRUE;
660 break;
662 case 'o':
664 /* Produce AML offset table in C */
666 Gbl_C_OffsetTableFlag = TRUE;
667 break;
669 default:
671 printf ("Unknown option: -s%s\n", AcpiGbl_Optarg);
672 return (-1);
674 break;
676 case 't': /* Produce hex table output file */
678 switch (AcpiGbl_Optarg[0])
680 case 'a':
682 Gbl_HexOutputFlag = HEX_OUTPUT_ASM;
683 break;
685 case 'c':
687 Gbl_HexOutputFlag = HEX_OUTPUT_C;
688 break;
690 case 's':
692 Gbl_HexOutputFlag = HEX_OUTPUT_ASL;
693 break;
695 default:
697 printf ("Unknown option: -t%s\n", AcpiGbl_Optarg);
698 return (-1);
700 break;
702 case 'T': /* Create a ACPI table template file */
704 Gbl_DoTemplates = TRUE;
705 break;
707 case 'v': /* Version and verbosity settings */
709 switch (AcpiGbl_Optarg[0])
711 case '^':
713 printf (ACPI_COMMON_SIGNON (ASL_COMPILER_NAME));
714 exit (0);
716 case 'a':
718 /* Disable all error/warning/remark messages */
720 Gbl_NoErrors = TRUE;
721 break;
723 case 'd':
725 printf ("%s Build date/time: %s %s\n",
726 ASL_COMPILER_NAME, ASL_BUILD_DATE, ASL_BUILD_TIME);
727 exit (0);
729 case 'e':
731 /* Disable all warning/remark messages (errors only) */
733 Gbl_DisplayRemarks = FALSE;
734 Gbl_DisplayWarnings = FALSE;
735 break;
737 case 'i':
739 * Support for integrated development environment(s).
741 * 1) No compiler signon
742 * 2) Send stderr messages to stdout
743 * 3) Less verbose error messages (single line only for each)
744 * 4) Error/warning messages are formatted appropriately to
745 * be recognized by MS Visual Studio
747 Gbl_VerboseErrors = FALSE;
748 Gbl_DoSignon = FALSE;
749 Gbl_Files[ASL_FILE_STDERR].Handle = stdout;
750 break;
752 case 'o':
754 Gbl_DisplayOptimizations = TRUE;
755 break;
757 case 'r':
759 Gbl_DisplayRemarks = FALSE;
760 break;
762 case 's':
764 Gbl_DoSignon = FALSE;
765 break;
767 case 't':
769 Gbl_VerboseTemplates = TRUE;
770 break;
772 case 'w':
774 /* Get the required argument */
776 if (AcpiGetoptArgument (argc, argv))
778 return (-1);
781 Status = AslDisableException (AcpiGbl_Optarg);
782 if (ACPI_FAILURE (Status))
784 return (-1);
786 break;
788 default:
790 printf ("Unknown option: -v%s\n", AcpiGbl_Optarg);
791 return (-1);
793 break;
795 case 'w': /* Set warning levels */
797 switch (AcpiGbl_Optarg[0])
799 case '1':
801 Gbl_WarningLevel = ASL_WARNING;
802 break;
804 case '2':
806 Gbl_WarningLevel = ASL_WARNING2;
807 break;
809 case '3':
811 Gbl_WarningLevel = ASL_WARNING3;
812 break;
814 case 'e':
816 Gbl_WarningsAsErrors = TRUE;
817 break;
819 default:
821 printf ("Unknown option: -w%s\n", AcpiGbl_Optarg);
822 return (-1);
824 break;
826 case 'x': /* Set debug print output level */
828 AcpiDbgLevel = strtoul (AcpiGbl_Optarg, NULL, 16);
829 break;
831 case 'z':
833 Gbl_UseOriginalCompilerId = TRUE;
834 break;
836 default:
838 return (-1);
841 return (0);
845 /*******************************************************************************
847 * FUNCTION: AslMergeOptionTokens
849 * PARAMETERS: InBuffer - Input containing an option string
850 * OutBuffer - Merged output buffer
852 * RETURN: None
854 * DESCRIPTION: Remove all whitespace from an option string.
856 ******************************************************************************/
858 static void
859 AslMergeOptionTokens (
860 char *InBuffer,
861 char *OutBuffer)
863 char *Token;
866 *OutBuffer = 0;
868 Token = strtok (InBuffer, ASL_TOKEN_SEPARATORS);
869 while (Token)
871 strcat (OutBuffer, Token);
872 Token = strtok (NULL, ASL_TOKEN_SEPARATORS);
877 /*******************************************************************************
879 * FUNCTION: AslDoResponseFile
881 * PARAMETERS: Filename - Name of the response file
883 * RETURN: Status
885 * DESCRIPTION: Open a response file and process all options within.
887 ******************************************************************************/
889 static int
890 AslDoResponseFile (
891 char *Filename)
893 char *argv = StringBuffer2;
894 FILE *ResponseFile;
895 int OptStatus = 0;
896 int Opterr;
897 int Optind;
900 ResponseFile = fopen (Filename, "r");
901 if (!ResponseFile)
903 printf ("Could not open command file %s, %s\n",
904 Filename, strerror (errno));
905 return (-1);
908 /* Must save the current GetOpt globals */
910 Opterr = AcpiGbl_Opterr;
911 Optind = AcpiGbl_Optind;
914 * Process all lines in the response file. There must be one complete
915 * option per line
917 while (fgets (StringBuffer, ASL_MSG_BUFFER_SIZE, ResponseFile))
919 /* Compress all tokens, allowing us to use a single argv entry */
921 AslMergeOptionTokens (StringBuffer, StringBuffer2);
923 /* Process the option */
925 AcpiGbl_Opterr = 0;
926 AcpiGbl_Optind = 0;
928 OptStatus = AslDoOptions (1, &argv, TRUE);
929 if (OptStatus)
931 printf ("Invalid option in command file %s: %s\n",
932 Filename, StringBuffer);
933 break;
937 /* Restore the GetOpt globals */
939 AcpiGbl_Opterr = Opterr;
940 AcpiGbl_Optind = Optind;
942 fclose (ResponseFile);
943 return (OptStatus);