sys/contrib/dev/acpica/source/compiler/aslmain.c

   1 /******************************************************************************
   2  *
   3  * Module Name: aslmain - compiler main and utilities
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2015, 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 #define _DECLARE_GLOBALS
  45
  46 #include "aslcompiler.h"
  47 #include "acapps.h"
  48 #include "acdisasm.h"
  49 #include <signal.h>
  50
  51 #define _COMPONENT          ACPI_COMPILER
  52         ACPI_MODULE_NAME    ("aslmain")
  53
  54 /*
  55  * Main routine for the iASL compiler.
  56  *
  57  * Portability note: The compiler depends upon the host for command-line
  58  * wildcard support - it is not implemented locally. For example:
  59  *
  60  * Linux/Unix systems: Shell expands wildcards automatically.
  61  *
  62  * Windows: The setargv.obj module must be linked in to automatically
  63  * expand wildcards.
  64  */
  65
  66 /* Local prototypes */
  67
  68 static void ACPI_SYSTEM_XFACE
  69 AslSignalHandler (
  70     int                     Sig);
  71
  72 static void
  73 AslInitialize (
  74     void);
  75
  76 UINT8
  77 AcpiIsBigEndianMachine (
  78     void);
  79
  80
  81 /*******************************************************************************
  82  *
  83  * FUNCTION:    AcpiIsBigEndianMachine
  84  *
  85  * PARAMETERS:  None
  86  *
  87  * RETURN:      TRUE if machine is big endian
  88  *              FALSE if machine is little endian
  89  *
  90  * DESCRIPTION: Detect whether machine is little endian or big endian.
  91  *
  92  ******************************************************************************/
  93
  94 UINT8
  95 AcpiIsBigEndianMachine (
  96     void)
  97 {
  98     union {
  99         UINT32              Integer;
 100         UINT8               Bytes[4];
 101     } Overlay = {0xFF000000};
 102
 103     return (Overlay.Bytes[0]); /* Returns 0xFF (TRUE) for big endian */
 104 }
 105
 106
 107 /*******************************************************************************
 108  *
 109  * FUNCTION:    Usage
 110  *
 111  * PARAMETERS:  None
 112  *
 113  * RETURN:      None
 114  *
 115  * DESCRIPTION: Display option help message.
 116  *              Optional items in square brackets.
 117  *
 118  ******************************************************************************/
 119
 120 void
 121 Usage (
 122     void)
 123 {
 124     printf ("%s\n\n", ASL_COMPLIANCE);
 125     ACPI_USAGE_HEADER ("iasl [Options] [Files]");
 126
 127     printf ("\nGeneral:\n");
 128     ACPI_OPTION ("-@ <file>",       "Specify command file");
 129     ACPI_OPTION ("-I <dir>",        "Specify additional include directory");
 130     ACPI_OPTION ("-T <sig>|ALL|*",  "Create table template file for ACPI <Sig>");
 131     ACPI_OPTION ("-p <prefix>",     "Specify path/filename prefix for all output files");
 132     ACPI_OPTION ("-v",              "Display compiler version");
 133     ACPI_OPTION ("-vo",             "Enable optimization comments");
 134     ACPI_OPTION ("-vs",             "Disable signon");
 135
 136     printf ("\nHelp:\n");
 137     ACPI_OPTION ("-h",              "This message");
 138     ACPI_OPTION ("-hc",             "Display operators allowed in constant expressions");
 139     ACPI_OPTION ("-hf",             "Display help for output filename generation");
 140     ACPI_OPTION ("-hr",             "Display ACPI reserved method names");
 141     ACPI_OPTION ("-ht",             "Display currently supported ACPI table names");
 142
 143     printf ("\nPreprocessor:\n");
 144     ACPI_OPTION ("-D <symbol>",     "Define symbol for preprocessor use");
 145     ACPI_OPTION ("-li",             "Create preprocessed output file (*.i)");
 146     ACPI_OPTION ("-P",              "Preprocess only and create preprocessor output file (*.i)");
 147     ACPI_OPTION ("-Pn",             "Disable preprocessor");
 148
 149     printf ("\nErrors, Warnings, and Remarks:\n");
 150     ACPI_OPTION ("-va",             "Disable all errors/warnings/remarks");
 151     ACPI_OPTION ("-ve",             "Report only errors (ignore warnings and remarks)");
 152     ACPI_OPTION ("-vi",             "Less verbose errors and warnings for use with IDEs");
 153     ACPI_OPTION ("-vr",             "Disable remarks");
 154     ACPI_OPTION ("-vw <messageid>", "Disable specific warning or remark");
 155     ACPI_OPTION ("-w1 -w2 -w3",     "Set warning reporting level");
 156     ACPI_OPTION ("-we",             "Report warnings as errors");
 157
 158     printf ("\nAML Code Generation (*.aml):\n");
 159     ACPI_OPTION ("-oa",             "Disable all optimizations (compatibility mode)");
 160     ACPI_OPTION ("-of",             "Disable constant folding");
 161     ACPI_OPTION ("-oi",             "Disable integer optimization to Zero/One/Ones");
 162     ACPI_OPTION ("-on",             "Disable named reference string optimization");
 163     ACPI_OPTION ("-cr",             "Disable Resource Descriptor error checking");
 164     ACPI_OPTION ("-in",             "Ignore NoOp operators");
 165     ACPI_OPTION ("-r <revision>",   "Override table header Revision (1-255)");
 166
 167     printf ("\nOptional Source Code Output Files:\n");
 168     ACPI_OPTION ("-sc -sa",         "Create source file in C or assembler (*.c or *.asm)");
 169     ACPI_OPTION ("-ic -ia",         "Create include file in C or assembler (*.h or *.inc)");
 170     ACPI_OPTION ("-tc -ta -ts",     "Create hex AML table in C, assembler, or ASL (*.hex)");
 171     ACPI_OPTION ("-so",             "Create offset table in C (*.offset.h)");
 172
 173     printf ("\nOptional Listing Files:\n");
 174     ACPI_OPTION ("-l",              "Create mixed listing file (ASL source and AML) (*.lst)");
 175     ACPI_OPTION ("-lm",             "Create hardware summary map file (*.map)");
 176     ACPI_OPTION ("-ln",             "Create namespace file (*.nsp)");
 177     ACPI_OPTION ("-ls",             "Create combined source file (expanded includes) (*.src)");
 178
 179     printf ("\nData Table Compiler:\n");
 180     ACPI_OPTION ("-G",              "Compile custom table that contains generic operators");
 181     ACPI_OPTION ("-vt",             "Create verbose template files (full disassembly)");
 182
 183     printf ("\nAML Disassembler:\n");
 184     ACPI_OPTION ("-d  <f1 f2 ...>", "Disassemble or decode binary ACPI tables to file (*.dsl)");
 185     ACPI_OPTION ("",                "  (Optional, file type is automatically detected)");
 186     ACPI_OPTION ("-da <f1 f2 ...>", "Disassemble multiple tables from single namespace");
 187     ACPI_OPTION ("-db",             "Do not translate Buffers to Resource Templates");
 188     ACPI_OPTION ("-dc <f1 f2 ...>", "Disassemble AML and immediately compile it");
 189     ACPI_OPTION ("",                "  (Obtain DSDT from current system if no input file)");
 190     ACPI_OPTION ("-df",             "Force disassembler to assume table contains valid AML");
 191     ACPI_OPTION ("-dl",             "Emit legacy ASL code only (no C-style operators)");
 192     ACPI_OPTION ("-e  <f1 f2 ...>", "Include ACPI table(s) for external symbol resolution");
 193     ACPI_OPTION ("-fe <file>",      "Specify external symbol declaration file");
 194     ACPI_OPTION ("-in",             "Ignore NoOp opcodes");
 195     ACPI_OPTION ("-vt",             "Dump binary table data in hex format within output file");
 196
 197     printf ("\nDebug Options:\n");
 198     ACPI_OPTION ("-bf",             "Create debug file (full output) (*.txt)");
 199     ACPI_OPTION ("-bs",             "Create debug file (parse tree only) (*.txt)");
 200     ACPI_OPTION ("-bp <depth>",     "Prune ASL parse tree");
 201     ACPI_OPTION ("-bt <type>",      "Object type to be pruned from the parse tree");
 202     ACPI_OPTION ("-f",              "Ignore errors, force creation of AML output file(s)");
 203     ACPI_OPTION ("-m <size>",       "Set internal line buffer size (in Kbytes)");
 204     ACPI_OPTION ("-n",              "Parse only, no output generation");
 205     ACPI_OPTION ("-ot",             "Display compile times and statistics");
 206     ACPI_OPTION ("-x <level>",      "Set debug level for trace output");
 207     ACPI_OPTION ("-z",              "Do not insert new compiler ID for DataTables");
 208 }
 209
 210
 211 /*******************************************************************************
 212  *
 213  * FUNCTION:    FilenameHelp
 214  *
 215  * PARAMETERS:  None
 216  *
 217  * RETURN:      None
 218  *
 219  * DESCRIPTION: Display help message for output filename generation
 220  *
 221  ******************************************************************************/
 222
 223 void
 224 AslFilenameHelp (
 225     void)
 226 {
 227
 228     printf ("\nAML output filename generation:\n");
 229     printf ("  Output filenames are generated by appending an extension to a common\n");
 230     printf ("  filename prefix. The filename prefix is obtained via one of the\n");
 231     printf ("  following methods (in priority order):\n");
 232     printf ("    1) The -p option specifies the prefix\n");
 233     printf ("    2) The prefix of the AMLFileName in the ASL Definition Block\n");
 234     printf ("    3) The prefix of the input filename\n");
 235     printf ("\n");
 236 }
 237
 238
 239 /******************************************************************************
 240  *
 241  * FUNCTION:    AslSignalHandler
 242  *
 243  * PARAMETERS:  Sig                 - Signal that invoked this handler
 244  *
 245  * RETURN:      None
 246  *
 247  * DESCRIPTION: Control-C handler. Delete any intermediate files and any
 248  *              output files that may be left in an indeterminate state.
 249  *
 250  *****************************************************************************/
 251
 252 static void ACPI_SYSTEM_XFACE
 253 AslSignalHandler (
 254     int                     Sig)
 255 {
 256     UINT32                  i;
 257
 258
 259     signal (Sig, SIG_IGN);
 260     printf ("Aborting\n\n");
 261
 262     /* Close all open files */
 263
 264     Gbl_Files[ASL_FILE_PREPROCESSOR].Handle = NULL; /* the .pre file is same as source file */
 265
 266     for (i = ASL_FILE_INPUT; i < ASL_MAX_FILE_TYPE; i++)
 267     {
 268         FlCloseFile (i);
 269     }
 270
 271     /* Delete any output files */
 272
 273     for (i = ASL_FILE_AML_OUTPUT; i < ASL_MAX_FILE_TYPE; i++)
 274     {
 275         FlDeleteFile (i);
 276     }
 277
 278     exit (0);
 279 }
 280
 281
 282 /*******************************************************************************
 283  *
 284  * FUNCTION:    AslInitialize
 285  *
 286  * PARAMETERS:  None
 287  *
 288  * RETURN:      None
 289  *
 290  * DESCRIPTION: Initialize compiler globals
 291  *
 292  ******************************************************************************/
 293
 294 static void
 295 AslInitialize (
 296     void)
 297 {
 298     UINT32                  i;
 299
 300
 301     for (i = 0; i < ASL_NUM_FILES; i++)
 302     {
 303         Gbl_Files[i].Handle = NULL;
 304         Gbl_Files[i].Filename = NULL;
 305     }
 306
 307     Gbl_Files[ASL_FILE_STDOUT].Handle   = stdout;
 308     Gbl_Files[ASL_FILE_STDOUT].Filename = "STDOUT";
 309
 310     Gbl_Files[ASL_FILE_STDERR].Handle   = stderr;
 311     Gbl_Files[ASL_FILE_STDERR].Filename = "STDERR";
 312 }
 313
 314
 315 /*******************************************************************************
 316  *
 317  * FUNCTION:    main
 318  *
 319  * PARAMETERS:  Standard argc/argv
 320  *
 321  * RETURN:      Program termination code
 322  *
 323  * DESCRIPTION: C main routine for the Asl Compiler. Handle command line
 324  *              options and begin the compile for each file on the command line
 325  *
 326  ******************************************************************************/
 327
 328 int ACPI_SYSTEM_XFACE
 329 main (
 330     int                     argc,
 331     char                    **argv)
 332 {
 333     ACPI_STATUS             Status;
 334     int                     Index1;
 335     int                     Index2;
 336     int                     ReturnStatus = 0;
 337
 338
 339     /*
 340      * Big-endian machines are not currently supported. ACPI tables must
 341      * be little-endian, and support for big-endian machines needs to
 342      * be implemented.
 343      */
 344     if (AcpiIsBigEndianMachine ())
 345     {
 346         fprintf (stderr,
 347             "iASL is not currently supported on big-endian machines.\n");
 348         return (-1);
 349     }
 350
 351     AcpiOsInitialize ();
 352     ACPI_DEBUG_INITIALIZE (); /* For debug version only */
 353
 354     /* Initialize preprocessor and compiler before command line processing */
 355
 356     signal (SIGINT, AslSignalHandler);
 357     AcpiGbl_ExternalFileList = NULL;
 358     AcpiDbgLevel = 0;
 359     PrInitializePreprocessor ();
 360     AslInitialize ();
 361
 362     Index1 = Index2 = AslCommandLine (argc, argv);
 363
 364     /* Allocate the line buffer(s), must be after command line */
 365
 366     Gbl_LineBufferSize /= 2;
 367     UtExpandLineBuffers ();
 368
 369     /* Perform global actions first/only */
 370
 371     if (Gbl_DisassembleAll)
 372     {
 373         while (argv[Index1])
 374         {
 375             Status = AcpiDmAddToExternalFileList (argv[Index1]);
 376             if (ACPI_FAILURE (Status))
 377             {
 378                 return (-1);
 379             }
 380
 381             Index1++;
 382         }
 383     }
 384
 385     /* Process each pathname/filename in the list, with possible wildcards */
 386
 387     while (argv[Index2])
 388     {
 389         /*
 390          * If -p not specified, we will use the input filename as the
 391          * output filename prefix
 392          */
 393         if (Gbl_UseDefaultAmlFilename)
 394         {
 395             Gbl_OutputFilenamePrefix = argv[Index2];
 396             UtConvertBackslashes (Gbl_OutputFilenamePrefix);
 397         }
 398
 399         Status = AslDoOneFile (argv[Index2]);
 400         if (ACPI_FAILURE (Status))
 401         {
 402             ReturnStatus = -1;
 403             goto CleanupAndExit;
 404         }
 405
 406         Index2++;
 407     }
 408
 409
 410 CleanupAndExit:
 411
 412     UtFreeLineBuffers ();
 413     AslParserCleanup ();
 414
 415     if (AcpiGbl_ExternalFileList)
 416     {
 417         AcpiDmClearExternalFileList();
 418     }
 419
 420     return (ReturnStatus);
 421 }