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