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

   1 /******************************************************************************
   2  *
   3  * Module Name: aslmain - compiler main and utilities
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2019, Intel Corp.
  12  * All rights reserved.
  13  *
  14  * 2. License
  15  *
  16  * 2.1. This is your license from Intel Corp. under its intellectual property
  17  * rights. You may have additional license terms from the party that provided
  18  * you this software, covering your right to use that party's intellectual
  19  * property rights.
  20  *
  21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  22  * copy of the source code appearing in this file ("Covered Code") an
  23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  24  * base code distributed originally by Intel ("Original Intel Code") to copy,
  25  * make derivatives, distribute, use and display any portion of the Covered
  26  * Code in any form, with the right to sublicense such rights; and
  27  *
  28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  29  * license (with the right to sublicense), under only those claims of Intel
  30  * patents that are infringed by the Original Intel Code, to make, use, sell,
  31  * offer to sell, and import the Covered Code and derivative works thereof
  32  * solely to the minimum extent necessary to exercise the above copyright
  33  * license, and in no event shall the patent license extend to any additions
  34  * to or modifications of the Original Intel Code. No other license or right
  35  * is granted directly or by implication, estoppel or otherwise;
  36  *
  37  * The above copyright and patent license is granted only if the following
  38  * conditions are met:
  39  *
  40  * 3. Conditions
  41  *
  42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  43  * Redistribution of source code of any substantial portion of the Covered
  44  * Code or modification with rights to further distribute source must include
  45  * the above Copyright Notice, the above License, this list of Conditions,
  46  * and the following Disclaimer and Export Compliance provision. In addition,
  47  * Licensee must cause all Covered Code to which Licensee contributes to
  48  * contain a file documenting the changes Licensee made to create that Covered
  49  * Code and the date of any change. Licensee must include in that file the
  50  * documentation of any changes made by any predecessor Licensee. Licensee
  51  * must include a prominent statement that the modification is derived,
  52  * directly or indirectly, from Original Intel Code.
  53  *
  54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  55  * Redistribution of source code of any substantial portion of the Covered
  56  * Code or modification without rights to further distribute source must
  57  * include the following Disclaimer and Export Compliance provision in the
  58  * documentation and/or other materials provided with distribution. In
  59  * addition, Licensee may not authorize further sublicense of source of any
  60  * portion of the Covered Code, and must include terms to the effect that the
  61  * license from Licensee to its licensee is limited to the intellectual
  62  * property embodied in the software Licensee provides to its licensee, and
  63  * not to intellectual property embodied in modifications its licensee may
  64  * make.
  65  *
  66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  67  * substantial portion of the Covered Code or modification must reproduce the
  68  * above Copyright Notice, and the following Disclaimer and Export Compliance
  69  * provision in the documentation and/or other materials provided with the
  70  * distribution.
  71  *
  72  * 3.4. Intel retains all right, title, and interest in and to the Original
  73  * Intel Code.
  74  *
  75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  76  * Intel shall be used in advertising or otherwise to promote the sale, use or
  77  * other dealings in products derived from or relating to the Covered Code
  78  * without prior written authorization from Intel.
  79  *
  80  * 4. Disclaimer and Export Compliance
  81  *
  82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  83  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
  85  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
  86  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
  87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  88  * PARTICULAR PURPOSE.
  89  *
  90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
  96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  97  * LIMITED REMEDY.
  98  *
  99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 100  * software or system incorporating such software without first obtaining any
 101  * required license or other approval from the U. S. Department of Commerce or
 102  * any other agency or department of the United States Government. In the
 103  * event Licensee exports any such software from the United States or
 104  * re-exports any such software from a foreign destination, Licensee shall
 105  * ensure that the distribution and export/re-export of the software is in
 106  * compliance with all laws, regulations, orders, or other restrictions of the
 107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 108  * any of its subsidiaries will export/re-export any technical data, process,
 109  * software, or service, directly or indirectly, to any country for which the
 110  * United States government or any agency thereof requires an export license,
 111  * other governmental approval, or letter of assurance, without first obtaining
 112  * such license, approval or letter.
 113  *
 114  *****************************************************************************
 115  *
 116  * Alternatively, you may choose to be licensed under the terms of the
 117  * following license:
 118  *
 119  * Redistribution and use in source and binary forms, with or without
 120  * modification, are permitted provided that the following conditions
 121  * are met:
 122  * 1. Redistributions of source code must retain the above copyright
 123  *    notice, this list of conditions, and the following disclaimer,
 124  *    without modification.
 125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
 126  *    substantially similar to the "NO WARRANTY" disclaimer below
 127  *    ("Disclaimer") and any redistribution must be conditioned upon
 128  *    including a substantially similar Disclaimer requirement for further
 129  *    binary redistribution.
 130  * 3. Neither the names of the above-listed copyright holders nor the names
 131  *    of any contributors may be used to endorse or promote products derived
 132  *    from this software without specific prior written permission.
 133  *
 134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 145  *
 146  * Alternatively, you may choose to be licensed under the terms of the
 147  * GNU General Public License ("GPL") version 2 as published by the Free
 148  * Software Foundation.
 149  *
 150  *****************************************************************************/
 151
 152 #define _DECLARE_GLOBALS
 153
 154 #include "aslcompiler.h"
 155 #include "acapps.h"
 156 #include "acdisasm.h"
 157 #include <signal.h>
 158
 159 #define _COMPONENT          ACPI_COMPILER
 160         ACPI_MODULE_NAME    ("aslmain")
 161
 162 /*
 163  * Main routine for the iASL compiler.
 164  *
 165  * Portability note: The compiler depends upon the host for command-line
 166  * wildcard support - it is not implemented locally. For example:
 167  *
 168  * Linux/Unix systems: Shell expands wildcards automatically.
 169  *
 170  * Windows: The setargv.obj module must be linked in to automatically
 171  * expand wildcards.
 172  */
 173
 174 /* Local prototypes */
 175
 176 static void ACPI_SYSTEM_XFACE
 177 AslSignalHandler (
 178     int                     Sig);
 179
 180 static void
 181 AslInitialize (
 182     void);
 183
 184
 185 /*******************************************************************************
 186  *
 187  * FUNCTION:    main
 188  *
 189  * PARAMETERS:  Standard argc/argv
 190  *
 191  * RETURN:      Program termination code
 192  *
 193  * DESCRIPTION: C main routine for the iASL Compiler/Disassembler. Process
 194  *  command line options and begin the compile/disassembly for each file on
 195  *  the command line (wildcards supported).
 196  *
 197  ******************************************************************************/
 198
 199 int ACPI_SYSTEM_XFACE
 200 main (
 201     int                     argc,
 202     char                    **argv)
 203 {
 204     ACPI_STATUS             Status;
 205     int                     Index1;
 206     int                     Index2;
 207     int                     ReturnStatus = 0;
 208
 209
 210     signal (SIGINT, AslSignalHandler);
 211
 212     /*
 213      * Big-endian machines are not currently supported. ACPI tables must
 214      * be little-endian, and support for big-endian machines needs to
 215      * be implemented.
 216      */
 217     if (UtIsBigEndianMachine ())
 218     {
 219         fprintf (stderr,
 220             "iASL is not currently supported on big-endian machines.\n");
 221         return (-1);
 222     }
 223
 224     AcpiOsInitialize ();
 225     ACPI_DEBUG_INITIALIZE (); /* For debug version only */
 226
 227     /* Initialize preprocessor and compiler before command line processing */
 228
 229     AcpiGbl_ExternalFileList = NULL;
 230     AcpiDbgLevel = 0;
 231     PrInitializePreprocessor ();
 232     AslInitialize ();
 233
 234     Index1 = Index2 =
 235         AslCommandLine (argc, argv);
 236
 237     /* Allocate the line buffer(s), must be after command line */
 238
 239     AslGbl_LineBufferSize /= 2;
 240     UtExpandLineBuffers ();
 241
 242     /* Perform global actions first/only */
 243
 244     if (AslGbl_DisassembleAll)
 245     {
 246         while (argv[Index1])
 247         {
 248             Status = AcpiDmAddToExternalFileList (argv[Index1]);
 249             if (ACPI_FAILURE (Status))
 250             {
 251                 return (-1);
 252             }
 253
 254             Index1++;
 255         }
 256     }
 257
 258     /* ACPICA subsystem initialization */
 259
 260     Status = AdInitialize ();
 261     if (ACPI_FAILURE (Status))
 262     {
 263         return (Status);
 264     }
 265
 266
 267     /* Process each pathname/filename in the list, with possible wildcards */
 268
 269     while (argv[Index2])
 270     {
 271         /*
 272          * If -p not specified, we will use the input filename as the
 273          * output filename prefix
 274          */
 275         if (AslGbl_UseDefaultAmlFilename)
 276         {
 277             AslGbl_OutputFilenamePrefix = argv[Index2];
 278             UtConvertBackslashes (AslGbl_OutputFilenamePrefix);
 279         }
 280
 281         Status = AslDoOneFile (argv[Index2]);
 282         if (ACPI_FAILURE (Status))
 283         {
 284             ReturnStatus = -1;
 285             goto CleanupAndExit;
 286         }
 287
 288         Index2++;
 289     }
 290
 291     /*
 292      * At this point, compilation of a data table or disassembly is complete.
 293      */
 294     if (AslGbl_PreprocessOnly || AcpiGbl_DisasmFlag ||
 295         AslGbl_FileType == ASL_INPUT_TYPE_ASCII_DATA)
 296     {
 297         goto CleanupAndExit;
 298     }
 299
 300     CmDoAslMiddleAndBackEnd ();
 301
 302     /*
 303      * At this point, all semantic analysis has been completed. Check
 304      * expected error messages before cleanup or conversion.
 305      */
 306     AslCheckExpectedExceptions ();
 307
 308     /* ASL-to-ASL+ conversion - Perform immediate disassembly */
 309
 310     if (AslGbl_DoAslConversion)
 311     {
 312         /* re-initialize ACPICA subsystem for disassembler */
 313
 314         Status = AdInitialize ();
 315         if (ACPI_FAILURE (Status))
 316         {
 317             return (Status);
 318         }
 319
 320         /*
 321          * New input file is the output AML file from above.
 322          * New output is from the input ASL file from above.
 323          */
 324         AslGbl_OutputFilenamePrefix = AslGbl_Files[ASL_FILE_INPUT].Filename;
 325         AslGbl_Files[ASL_FILE_INPUT].Filename =
 326             AslGbl_Files[ASL_FILE_AML_OUTPUT].Filename;
 327
 328         CvDbgPrint ("Output filename: %s\n", AslGbl_OutputFilenamePrefix);
 329         fprintf (stderr, "\n");
 330
 331         AcpiGbl_DisasmFlag = TRUE;
 332         AslDoDisassembly ();
 333         AcpiGbl_DisasmFlag = FALSE;
 334
 335         /* delete the AML file. This AML file should never be utilized by AML interpreters. */
 336
 337         FlDeleteFile (ASL_FILE_AML_OUTPUT);
 338     }
 339
 340
 341
 342 CleanupAndExit:
 343
 344     UtFreeLineBuffers ();
 345     AslParserCleanup ();
 346     AcpiDmClearExternalFileList();
 347     (void) AcpiTerminate ();
 348
 349     /* CmCleanupAndExit is intended for the compiler only */
 350
 351     if (!AcpiGbl_DisasmFlag)
 352     {
 353         CmCleanupAndExit ();
 354     }
 355
 356
 357     return (ReturnStatus);
 358 }
 359
 360
 361 /******************************************************************************
 362  *
 363  * FUNCTION:    AslSignalHandler
 364  *
 365  * PARAMETERS:  Sig                 - Signal that invoked this handler
 366  *
 367  * RETURN:      None
 368  *
 369  * DESCRIPTION: Signal interrupt handler. Delete any intermediate files and
 370  *              any output files that may be left in an indeterminate state.
 371  *              Currently handles SIGINT (control-c).
 372  *
 373  *****************************************************************************/
 374
 375 static void ACPI_SYSTEM_XFACE
 376 AslSignalHandler (
 377     int                     Sig)
 378 {
 379     UINT32                  i;
 380
 381
 382     signal (Sig, SIG_IGN);
 383     fflush (stdout);
 384     fflush (stderr);
 385
 386     switch (Sig)
 387     {
 388     case SIGINT:
 389
 390         printf ("\n" ASL_PREFIX "<Control-C>\n");
 391         break;
 392
 393     default:
 394
 395         printf (ASL_PREFIX "Unknown interrupt signal (%d)\n", Sig);
 396         break;
 397     }
 398
 399     /*
 400      * Close all open files
 401      * Note: the .pre file is the same as the input source file
 402      */
 403     AslGbl_Files[ASL_FILE_PREPROCESSOR].Handle = NULL;
 404
 405     for (i = ASL_FILE_INPUT; i < ASL_MAX_FILE_TYPE; i++)
 406     {
 407         FlCloseFile (i);
 408     }
 409
 410     /* Delete any output files */
 411
 412     for (i = ASL_FILE_AML_OUTPUT; i < ASL_MAX_FILE_TYPE; i++)
 413     {
 414         FlDeleteFile (i);
 415     }
 416
 417     printf (ASL_PREFIX "Terminating\n");
 418     exit (0);
 419 }
 420
 421
 422 /*******************************************************************************
 423  *
 424  * FUNCTION:    AslInitialize
 425  *
 426  * PARAMETERS:  None
 427  *
 428  * RETURN:      None
 429  *
 430  * DESCRIPTION: Initialize compiler globals
 431  *
 432  ******************************************************************************/
 433
 434 static void
 435 AslInitialize (
 436     void)
 437 {
 438     AcpiGbl_DmOpt_Verbose = FALSE;
 439
 440     /* Default integer width is 32 bits */
 441
 442     AcpiGbl_IntegerBitWidth = 32;
 443     AcpiGbl_IntegerNybbleWidth = 8;
 444     AcpiGbl_IntegerByteWidth = 4;
 445 }