1 /****************************************************************************** 2 * 3 * Module Name: asloptions - compiler command line processing 4 * 5 *****************************************************************************/ 6 7 /* 8 * Copyright (C) 2000 - 2016, Intel Corp. 9 * All rights reserved. 10 * 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. 25 * 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. 29 * 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. 42 */ 43 44 #include "aslcompiler.h" 45 #include "acapps.h" 46 #include "acdisasm.h" 47 48 #define _COMPONENT ACPI_COMPILER 49 ACPI_MODULE_NAME ("asloption") 50 51 52 /* Local prototypes */ 53 54 static int 55 AslDoOptions ( 56 int argc, 57 char **argv, 58 BOOLEAN IsResponseFile); 59 60 static void 61 AslMergeOptionTokens ( 62 char *InBuffer, 63 char *OutBuffer); 64 65 static int 66 AslDoResponseFile ( 67 char *Filename); 68 69 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" 72 73 74 /******************************************************************************* 75 * 76 * FUNCTION: AslCommandLine 77 * 78 * PARAMETERS: argc/argv 79 * 80 * RETURN: Last argv index 81 * 82 * DESCRIPTION: Command line processing 83 * 84 ******************************************************************************/ 85 86 int 87 AslCommandLine ( 88 int argc, 89 char **argv) 90 { 91 int BadCommandLine = 0; 92 ACPI_STATUS Status; 93 94 95 /* Minimum command line contains at least the command and an input file */ 96 97 if (argc < 2) 98 { 99 printf (ACPI_COMMON_SIGNON (ASL_COMPILER_NAME)); 100 Usage (); 101 exit (1); 102 } 103 104 /* Process all command line options */ 105 106 BadCommandLine = AslDoOptions (argc, argv, FALSE); 107 108 if (Gbl_DoTemplates) 109 { 110 Status = DtCreateTemplates (argv); 111 if (ACPI_FAILURE (Status)) 112 { 113 exit (-1); 114 } 115 exit (1); 116 } 117 118 /* Next parameter must be the input filename */ 119 120 if (!argv[AcpiGbl_Optind] && 121 !Gbl_DisasmFlag) 122 { 123 printf ("Missing input filename\n"); 124 BadCommandLine = TRUE; 125 } 126 127 if (Gbl_DoSignon) 128 { 129 printf (ACPI_COMMON_SIGNON (ASL_COMPILER_NAME)); 130 if (Gbl_IgnoreErrors) 131 { 132 printf ("Ignoring all errors, forcing AML file generation\n\n"); 133 } 134 } 135 136 if (BadCommandLine) 137 { 138 printf ("Use -h option for help information\n"); 139 exit (1); 140 } 141 142 return (AcpiGbl_Optind); 143 } 144 145 146 /******************************************************************************* 147 * 148 * FUNCTION: AslDoOptions 149 * 150 * PARAMETERS: argc/argv - Standard argc/argv 151 * IsResponseFile - TRUE if executing a response file. 152 * 153 * RETURN: Status 154 * 155 * DESCRIPTION: Command line option processing 156 * 157 ******************************************************************************/ 158 159 static int 160 AslDoOptions ( 161 int argc, 162 char **argv, 163 BOOLEAN IsResponseFile) 164 { 165 ACPI_STATUS Status; 166 UINT32 j; 167 168 169 /* Get the command line options */ 170 171 while ((j = AcpiGetopt (argc, argv, ASL_SUPPORTED_OPTIONS)) != ACPI_OPT_END) switch (j) 172 { 173 case '@': /* Begin a response file */ 174 175 if (IsResponseFile) 176 { 177 printf ("Nested command files are not supported\n"); 178 return (-1); 179 } 180 181 if (AslDoResponseFile (AcpiGbl_Optarg)) 182 { 183 return (-1); 184 } 185 break; 186 187 case 'a': /* Debug options */ 188 189 switch (AcpiGbl_Optarg[0]) 190 { 191 case 'r': 192 193 Gbl_EnableReferenceTypechecking = TRUE; 194 break; 195 196 default: 197 198 printf ("Unknown option: -a%s\n", AcpiGbl_Optarg); 199 return (-1); 200 } 201 202 break; 203 204 205 case 'b': /* Debug options */ 206 207 switch (AcpiGbl_Optarg[0]) 208 { 209 case 'f': 210 211 AslCompilerdebug = 1; /* same as yydebug */ 212 DtParserdebug = 1; 213 PrParserdebug = 1; 214 Gbl_DebugFlag = TRUE; 215 Gbl_KeepPreprocessorTempFile = TRUE; 216 break; 217 218 case 'p': /* Prune ASL parse tree */ 219 220 /* Get the required argument */ 221 222 if (AcpiGetoptArgument (argc, argv)) 223 { 224 return (-1); 225 } 226 227 Gbl_PruneParseTree = TRUE; 228 Gbl_PruneDepth = (UINT8) strtoul (AcpiGbl_Optarg, NULL, 0); 229 break; 230 231 case 's': 232 233 Gbl_DebugFlag = TRUE; 234 break; 235 236 case 't': 237 238 /* Get the required argument */ 239 240 if (AcpiGetoptArgument (argc, argv)) 241 { 242 return (-1); 243 } 244 245 Gbl_PruneType = (UINT8) strtoul (AcpiGbl_Optarg, NULL, 0); 246 break; 247 248 default: 249 250 printf ("Unknown option: -b%s\n", AcpiGbl_Optarg); 251 return (-1); 252 } 253 254 break; 255 256 case 'c': 257 258 switch (AcpiGbl_Optarg[0]) 259 { 260 case 'r': 261 262 Gbl_NoResourceChecking = TRUE; 263 break; 264 265 default: 266 267 printf ("Unknown option: -c%s\n", AcpiGbl_Optarg); 268 return (-1); 269 } 270 break; 271 272 case 'd': /* Disassembler */ 273 274 switch (AcpiGbl_Optarg[0]) 275 { 276 case '^': 277 278 /* Get the required argument */ 279 280 if (AcpiGetoptArgument (argc, argv)) 281 { 282 return (-1); 283 } 284 285 Gbl_DoCompile = FALSE; 286 break; 287 288 case 'a': 289 290 /* Get the required argument */ 291 292 if (AcpiGetoptArgument (argc, argv)) 293 { 294 return (-1); 295 } 296 297 Gbl_DoCompile = FALSE; 298 Gbl_DisassembleAll = TRUE; 299 break; 300 301 case 'b': /* Do not convert buffers to resource descriptors */ 302 303 AcpiGbl_NoResourceDisassembly = TRUE; 304 break; 305 306 case 'c': 307 308 break; 309 310 case 'f': 311 312 AcpiGbl_ForceAmlDisassembly = TRUE; 313 break; 314 315 case 'l': /* Use legacy ASL code (not ASL+) for disassembly */ 316 317 Gbl_DoCompile = FALSE; 318 AcpiGbl_CstyleDisassembly = FALSE; 319 break; 320 321 default: 322 323 printf ("Unknown option: -d%s\n", AcpiGbl_Optarg); 324 return (-1); 325 } 326 327 Gbl_DisasmFlag = TRUE; 328 break; 329 330 case 'D': /* Define a symbol */ 331 332 PrAddDefine (AcpiGbl_Optarg, NULL, TRUE); 333 break; 334 335 case 'e': /* External files for disassembler */ 336 337 /* Get entire list of external files */ 338 339 AcpiGbl_Optind--; 340 argv[AcpiGbl_Optind] = AcpiGbl_Optarg; 341 342 while (argv[AcpiGbl_Optind] && 343 (argv[AcpiGbl_Optind][0] != '-')) 344 { 345 Status = AcpiDmAddToExternalFileList (argv[AcpiGbl_Optind]); 346 if (ACPI_FAILURE (Status)) 347 { 348 printf ("Could not add %s to external list\n", 349 argv[AcpiGbl_Optind]); 350 return (-1); 351 } 352 353 AcpiGbl_Optind++; 354 } 355 break; 356 357 case 'f': 358 359 switch (AcpiGbl_Optarg[0]) 360 { 361 case '^': /* Ignore errors and force creation of aml file */ 362 363 Gbl_IgnoreErrors = TRUE; 364 break; 365 366 case 'e': /* Disassembler: Get external declaration file */ 367 368 if (AcpiGetoptArgument (argc, argv)) 369 { 370 return (-1); 371 } 372 373 Gbl_ExternalRefFilename = AcpiGbl_Optarg; 374 break; 375 376 default: 377 378 printf ("Unknown option: -f%s\n", AcpiGbl_Optarg); 379 return (-1); 380 } 381 break; 382 383 case 'G': 384 385 Gbl_CompileGeneric = TRUE; 386 break; 387 388 case 'g': /* Get all ACPI tables */ 389 390 printf ("-g option is deprecated, use acpidump utility instead\n"); 391 exit (1); 392 393 case 'h': 394 395 switch (AcpiGbl_Optarg[0]) 396 { 397 case '^': 398 399 Usage (); 400 exit (0); 401 402 case 'c': 403 404 UtDisplayConstantOpcodes (); 405 exit (0); 406 407 case 'f': 408 409 AslFilenameHelp (); 410 exit (0); 411 412 case 'r': 413 414 /* reserved names */ 415 416 ApDisplayReservedNames (); 417 exit (0); 418 419 case 't': 420 421 UtDisplaySupportedTables (); 422 exit (0); 423 424 default: 425 426 printf ("Unknown option: -h%s\n", AcpiGbl_Optarg); 427 return (-1); 428 } 429 430 case 'I': /* Add an include file search directory */ 431 432 FlAddIncludeDirectory (AcpiGbl_Optarg); 433 break; 434 435 case 'i': /* Output AML as an include file */ 436 437 switch (AcpiGbl_Optarg[0]) 438 { 439 case 'a': 440 441 /* Produce assembly code include file */ 442 443 Gbl_AsmIncludeOutputFlag = TRUE; 444 break; 445 446 case 'c': 447 448 /* Produce C include file */ 449 450 Gbl_C_IncludeOutputFlag = TRUE; 451 break; 452 453 case 'n': 454 455 /* Compiler/Disassembler: Ignore the NOOP operator */ 456 457 AcpiGbl_IgnoreNoopOperator = TRUE; 458 break; 459 460 default: 461 462 printf ("Unknown option: -i%s\n", AcpiGbl_Optarg); 463 return (-1); 464 } 465 break; 466 467 case 'l': /* Listing files */ 468 469 switch (AcpiGbl_Optarg[0]) 470 { 471 case '^': 472 473 /* Produce listing file (Mixed source/aml) */ 474 475 Gbl_ListingFlag = TRUE; 476 AcpiGbl_DmOpt_Listing = TRUE; 477 break; 478 479 case 'i': 480 481 /* Produce preprocessor output file */ 482 483 Gbl_PreprocessorOutputFlag = TRUE; 484 break; 485 486 case 'm': 487 488 /* Produce hardware map summary file */ 489 490 Gbl_MapfileFlag = TRUE; 491 break; 492 493 case 'n': 494 495 /* Produce namespace file */ 496 497 Gbl_NsOutputFlag = TRUE; 498 break; 499 500 case 's': 501 502 /* Produce combined source file */ 503 504 Gbl_SourceOutputFlag = TRUE; 505 break; 506 507 case 'x': 508 509 /* Produce cross-reference file */ 510 511 Gbl_CrossReferenceOutput = TRUE; 512 break; 513 514 default: 515 516 printf ("Unknown option: -l%s\n", AcpiGbl_Optarg); 517 return (-1); 518 } 519 break; 520 521 case 'm': /* Set line buffer size */ 522 523 Gbl_LineBufferSize = (UINT32) strtoul (AcpiGbl_Optarg, NULL, 0) * 1024; 524 if (Gbl_LineBufferSize < ASL_DEFAULT_LINE_BUFFER_SIZE) 525 { 526 Gbl_LineBufferSize = ASL_DEFAULT_LINE_BUFFER_SIZE; 527 } 528 printf ("Line Buffer Size: %u\n", Gbl_LineBufferSize); 529 break; 530 531 case 'n': /* Parse only */ 532 533 Gbl_ParseOnlyFlag = TRUE; 534 break; 535 536 case 'o': /* Control compiler AML optimizations */ 537 538 switch (AcpiGbl_Optarg[0]) 539 { 540 case 'a': 541 542 /* Disable all optimizations */ 543 544 Gbl_FoldConstants = FALSE; 545 Gbl_IntegerOptimizationFlag = FALSE; 546 Gbl_ReferenceOptimizationFlag = FALSE; 547 break; 548 549 case 'c': 550 551 /* Display compile time(s) */ 552 553 Gbl_CompileTimesFlag = TRUE; 554 break; 555 556 case 'e': 557 558 /* iASL: Disable External opcode generation */ 559 560 Gbl_DoExternals = FALSE; 561 562 /* Disassembler: Emit embedded external operators */ 563 564 AcpiGbl_DmEmitExternalOpcodes = TRUE; 565 break; 566 567 case 'f': 568 569 /* Disable folding on "normal" expressions */ 570 571 Gbl_FoldConstants = FALSE; 572 break; 573 574 case 'i': 575 576 /* Disable integer optimization to constants */ 577 578 Gbl_IntegerOptimizationFlag = FALSE; 579 break; 580 581 case 'n': 582 583 /* Disable named reference optimization */ 584 585 Gbl_ReferenceOptimizationFlag = FALSE; 586 break; 587 588 case 't': 589 590 /* Disable heavy typechecking */ 591 592 Gbl_DoTypechecking = FALSE; 593 break; 594 595 default: 596 597 printf ("Unknown option: -c%s\n", AcpiGbl_Optarg); 598 return (-1); 599 } 600 break; 601 602 case 'P': /* Preprocessor options */ 603 604 switch (AcpiGbl_Optarg[0]) 605 { 606 case '^': /* Proprocess only, emit (.i) file */ 607 608 Gbl_PreprocessOnly = TRUE; 609 Gbl_PreprocessorOutputFlag = TRUE; 610 break; 611 612 case 'n': /* Disable preprocessor */ 613 614 Gbl_PreprocessFlag = FALSE; 615 break; 616 617 default: 618 619 printf ("Unknown option: -P%s\n", AcpiGbl_Optarg); 620 return (-1); 621 } 622 break; 623 624 case 'p': /* Override default AML output filename */ 625 626 Gbl_OutputFilenamePrefix = AcpiGbl_Optarg; 627 UtConvertBackslashes (Gbl_OutputFilenamePrefix); 628 Gbl_UseDefaultAmlFilename = FALSE; 629 break; 630 631 case 'r': /* Override revision found in table header */ 632 633 Gbl_RevisionOverride = (UINT8) strtoul (AcpiGbl_Optarg, NULL, 0); 634 break; 635 636 case 's': /* Create AML in a source code file */ 637 638 switch (AcpiGbl_Optarg[0]) 639 { 640 case 'a': 641 642 /* Produce assembly code output file */ 643 644 Gbl_AsmOutputFlag = TRUE; 645 break; 646 647 case 'c': 648 649 /* Produce C hex output file */ 650 651 Gbl_C_OutputFlag = TRUE; 652 break; 653 654 case 'o': 655 656 /* Produce AML offset table in C */ 657 658 Gbl_C_OffsetTableFlag = TRUE; 659 break; 660 661 default: 662 663 printf ("Unknown option: -s%s\n", AcpiGbl_Optarg); 664 return (-1); 665 } 666 break; 667 668 case 't': /* Produce hex table output file */ 669 670 switch (AcpiGbl_Optarg[0]) 671 { 672 case 'a': 673 674 Gbl_HexOutputFlag = HEX_OUTPUT_ASM; 675 break; 676 677 case 'c': 678 679 Gbl_HexOutputFlag = HEX_OUTPUT_C; 680 break; 681 682 case 's': 683 684 Gbl_HexOutputFlag = HEX_OUTPUT_ASL; 685 break; 686 687 default: 688 689 printf ("Unknown option: -t%s\n", AcpiGbl_Optarg); 690 return (-1); 691 } 692 break; 693 694 case 'T': /* Create a ACPI table template file */ 695 696 Gbl_DoTemplates = TRUE; 697 break; 698 699 case 'v': /* Version and verbosity settings */ 700 701 switch (AcpiGbl_Optarg[0]) 702 { 703 case '^': 704 705 printf (ACPI_COMMON_SIGNON (ASL_COMPILER_NAME)); 706 exit (0); 707 708 case 'a': 709 710 /* Disable all error/warning/remark messages */ 711 712 Gbl_NoErrors = TRUE; 713 break; 714 715 case 'e': 716 717 /* Disable all warning/remark messages (errors only) */ 718 719 Gbl_DisplayRemarks = FALSE; 720 Gbl_DisplayWarnings = FALSE; 721 break; 722 723 case 'i': 724 /* 725 * Support for integrated development environment(s). 726 * 727 * 1) No compiler signon 728 * 2) Send stderr messages to stdout 729 * 3) Less verbose error messages (single line only for each) 730 * 4) Error/warning messages are formatted appropriately to 731 * be recognized by MS Visual Studio 732 */ 733 Gbl_VerboseErrors = FALSE; 734 Gbl_DoSignon = FALSE; 735 Gbl_Files[ASL_FILE_STDERR].Handle = stdout; 736 break; 737 738 case 'o': 739 740 Gbl_DisplayOptimizations = TRUE; 741 break; 742 743 case 'r': 744 745 Gbl_DisplayRemarks = FALSE; 746 break; 747 748 case 's': 749 750 Gbl_DoSignon = FALSE; 751 break; 752 753 case 't': 754 755 Gbl_VerboseTemplates = TRUE; 756 break; 757 758 case 'w': 759 760 /* Get the required argument */ 761 762 if (AcpiGetoptArgument (argc, argv)) 763 { 764 return (-1); 765 } 766 767 Status = AslDisableException (AcpiGbl_Optarg); 768 if (ACPI_FAILURE (Status)) 769 { 770 return (-1); 771 } 772 break; 773 774 default: 775 776 printf ("Unknown option: -v%s\n", AcpiGbl_Optarg); 777 return (-1); 778 } 779 break; 780 781 case 'w': /* Set warning levels */ 782 783 switch (AcpiGbl_Optarg[0]) 784 { 785 case '1': 786 787 Gbl_WarningLevel = ASL_WARNING; 788 break; 789 790 case '2': 791 792 Gbl_WarningLevel = ASL_WARNING2; 793 break; 794 795 case '3': 796 797 Gbl_WarningLevel = ASL_WARNING3; 798 break; 799 800 case 'e': 801 802 Gbl_WarningsAsErrors = TRUE; 803 break; 804 805 default: 806 807 printf ("Unknown option: -w%s\n", AcpiGbl_Optarg); 808 return (-1); 809 } 810 break; 811 812 case 'x': /* Set debug print output level */ 813 814 AcpiDbgLevel = strtoul (AcpiGbl_Optarg, NULL, 16); 815 break; 816 817 case 'z': 818 819 Gbl_UseOriginalCompilerId = TRUE; 820 break; 821 822 default: 823 824 return (-1); 825 } 826 827 return (0); 828 } 829 830 831 /******************************************************************************* 832 * 833 * FUNCTION: AslMergeOptionTokens 834 * 835 * PARAMETERS: InBuffer - Input containing an option string 836 * OutBuffer - Merged output buffer 837 * 838 * RETURN: None 839 * 840 * DESCRIPTION: Remove all whitespace from an option string. 841 * 842 ******************************************************************************/ 843 844 static void 845 AslMergeOptionTokens ( 846 char *InBuffer, 847 char *OutBuffer) 848 { 849 char *Token; 850 851 852 *OutBuffer = 0; 853 854 Token = strtok (InBuffer, ASL_TOKEN_SEPARATORS); 855 while (Token) 856 { 857 strcat (OutBuffer, Token); 858 Token = strtok (NULL, ASL_TOKEN_SEPARATORS); 859 } 860 } 861 862 863 /******************************************************************************* 864 * 865 * FUNCTION: AslDoResponseFile 866 * 867 * PARAMETERS: Filename - Name of the response file 868 * 869 * RETURN: Status 870 * 871 * DESCRIPTION: Open a response file and process all options within. 872 * 873 ******************************************************************************/ 874 875 static int 876 AslDoResponseFile ( 877 char *Filename) 878 { 879 char *argv = StringBuffer2; 880 FILE *ResponseFile; 881 int OptStatus = 0; 882 int Opterr; 883 int Optind; 884 885 886 ResponseFile = fopen (Filename, "r"); 887 if (!ResponseFile) 888 { 889 printf ("Could not open command file %s, %s\n", 890 Filename, strerror (errno)); 891 return (-1); 892 } 893 894 /* Must save the current GetOpt globals */ 895 896 Opterr = AcpiGbl_Opterr; 897 Optind = AcpiGbl_Optind; 898 899 /* 900 * Process all lines in the response file. There must be one complete 901 * option per line 902 */ 903 while (fgets (StringBuffer, ASL_MSG_BUFFER_SIZE, ResponseFile)) 904 { 905 /* Compress all tokens, allowing us to use a single argv entry */ 906 907 AslMergeOptionTokens (StringBuffer, StringBuffer2); 908 909 /* Process the option */ 910 911 AcpiGbl_Opterr = 0; 912 AcpiGbl_Optind = 0; 913 914 OptStatus = AslDoOptions (1, &argv, TRUE); 915 if (OptStatus) 916 { 917 printf ("Invalid option in command file %s: %s\n", 918 Filename, StringBuffer); 919 break; 920 } 921 } 922 923 /* Restore the GetOpt globals */ 924 925 AcpiGbl_Opterr = Opterr; 926 AcpiGbl_Optind = Optind; 927 928 fclose (ResponseFile); 929 return (OptStatus); 930 } 931