FreeBSD/Linux Kernel Cross Reference
sys/contrib/dev/acpica/compiler/aslstartup.c

     /******************************************************************************
      *
      * Module Name: aslstartup - Compiler startup routines, called from main
      *
      *****************************************************************************/
     
     /******************************************************************************
      *
      * 1. Copyright Notice
     *
     * Some or all of this work - Copyright (c) 1999 - 2022, Intel Corp.
     * All rights reserved.
     *
     * 2. License
     *
     * 2.1. This is your license from Intel Corp. under its intellectual property
     * rights. You may have additional license terms from the party that provided
     * you this software, covering your right to use that party's intellectual
     * property rights.
     *
     * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
     * copy of the source code appearing in this file ("Covered Code") an
     * irrevocable, perpetual, worldwide license under Intel's copyrights in the
     * base code distributed originally by Intel ("Original Intel Code") to copy,
     * make derivatives, distribute, use and display any portion of the Covered
     * Code in any form, with the right to sublicense such rights; and
     *
     * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
     * license (with the right to sublicense), under only those claims of Intel
     * patents that are infringed by the Original Intel Code, to make, use, sell,
     * offer to sell, and import the Covered Code and derivative works thereof
     * solely to the minimum extent necessary to exercise the above copyright
     * license, and in no event shall the patent license extend to any additions
     * to or modifications of the Original Intel Code. No other license or right
     * is granted directly or by implication, estoppel or otherwise;
     *
     * The above copyright and patent license is granted only if the following
     * conditions are met:
     *
     * 3. Conditions
     *
     * 3.1. Redistribution of Source with Rights to Further Distribute Source.
     * Redistribution of source code of any substantial portion of the Covered
     * Code or modification with rights to further distribute source must include
     * the above Copyright Notice, the above License, this list of Conditions,
     * and the following Disclaimer and Export Compliance provision. In addition,
     * Licensee must cause all Covered Code to which Licensee contributes to
     * contain a file documenting the changes Licensee made to create that Covered
     * Code and the date of any change. Licensee must include in that file the
     * documentation of any changes made by any predecessor Licensee. Licensee
     * must include a prominent statement that the modification is derived,
     * directly or indirectly, from Original Intel Code.
     *
     * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
     * Redistribution of source code of any substantial portion of the Covered
     * Code or modification without rights to further distribute source must
     * include the following Disclaimer and Export Compliance provision in the
     * documentation and/or other materials provided with distribution. In
     * addition, Licensee may not authorize further sublicense of source of any
     * portion of the Covered Code, and must include terms to the effect that the
     * license from Licensee to its licensee is limited to the intellectual
     * property embodied in the software Licensee provides to its licensee, and
     * not to intellectual property embodied in modifications its licensee may
     * make.
     *
     * 3.3. Redistribution of Executable. Redistribution in executable form of any
     * substantial portion of the Covered Code or modification must reproduce the
     * above Copyright Notice, and the following Disclaimer and Export Compliance
     * provision in the documentation and/or other materials provided with the
     * distribution.
     *
     * 3.4. Intel retains all right, title, and interest in and to the Original
     * Intel Code.
     *
     * 3.5. Neither the name Intel nor any other trademark owned or controlled by
     * Intel shall be used in advertising or otherwise to promote the sale, use or
     * other dealings in products derived from or relating to the Covered Code
     * without prior written authorization from Intel.
     *
     * 4. Disclaimer and Export Compliance
     *
     * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
     * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
     * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
     * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
     * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
     * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
     * PARTICULAR PURPOSE.
     *
     * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
     * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
     * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
     * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
     * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
     * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
     * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
     * LIMITED REMEDY.
     *
     * 4.3. Licensee shall not export, either directly or indirectly, any of this
    * software or system incorporating such software without first obtaining any
    * required license or other approval from the U. S. Department of Commerce or
    * any other agency or department of the United States Government. In the
    * event Licensee exports any such software from the United States or
    * re-exports any such software from a foreign destination, Licensee shall
    * ensure that the distribution and export/re-export of the software is in
    * compliance with all laws, regulations, orders, or other restrictions of the
    * U.S. Export Administration Regulations. Licensee agrees that neither it nor
    * any of its subsidiaries will export/re-export any technical data, process,
    * software, or service, directly or indirectly, to any country for which the
    * United States government or any agency thereof requires an export license,
    * other governmental approval, or letter of assurance, without first obtaining
    * such license, approval or letter.
    *
    *****************************************************************************
    *
    * Alternatively, you may choose to be licensed under the terms of the
    * following license:
    *
    * Redistribution and use in source and binary forms, with or without
    * modification, are permitted provided that the following conditions
    * are met:
    * 1. Redistributions of source code must retain the above copyright
    *    notice, this list of conditions, and the following disclaimer,
    *    without modification.
    * 2. Redistributions in binary form must reproduce at minimum a disclaimer
    *    substantially similar to the "NO WARRANTY" disclaimer below
    *    ("Disclaimer") and any redistribution must be conditioned upon
    *    including a substantially similar Disclaimer requirement for further
    *    binary redistribution.
    * 3. Neither the names of the above-listed copyright holders nor the names
    *    of any contributors may be used to endorse or promote products derived
    *    from this software without specific prior written permission.
    *
    * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
    * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
    * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
    * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
    * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
    * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
    * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
    * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    *
    * Alternatively, you may choose to be licensed under the terms of the
    * GNU General Public License ("GPL") version 2 as published by the Free
    * Software Foundation.
    *
    *****************************************************************************/
   
   #include <contrib/dev/acpica/compiler/aslcompiler.h>
   #include <contrib/dev/acpica/include/actables.h>
   #include <contrib/dev/acpica/include/acdisasm.h>
   #include <contrib/dev/acpica/include/acapps.h>
   #include <contrib/dev/acpica/include/acconvert.h>
   
   #define _COMPONENT          ACPI_COMPILER
           ACPI_MODULE_NAME    ("aslstartup")
   
   
   /* Local prototypes */
   
   static UINT8
   AslDetectSourceFileType (
       ASL_FILE_INFO           *Info);
   
   
   /* Globals */
   
   static BOOLEAN          AslToFile = TRUE;
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AslInitializeGlobals
    *
    * PARAMETERS:  None
    *
    * RETURN:      None
    *
    * DESCRIPTION: Re-initialize globals needed to restart the compiler. This
    *              allows multiple files to be disassembled and/or compiled.
    *
    ******************************************************************************/
   
   void
   AslInitializeGlobals (
       void)
   {
       UINT32                  i;
   
   
       /* Init compiler globals */
   
       AslGbl_SyntaxError = 0;
       AslGbl_CurrentColumn = 0;
       AslGbl_CurrentLineNumber = 1;
       AslGbl_LogicalLineNumber = 1;
       AslGbl_CurrentLineOffset = 0;
       AslGbl_InputFieldCount = 0;
       AslGbl_InputByteCount = 0;
       AslGbl_NsLookupCount = 0;
       AslGbl_LineBufPtr = AslGbl_CurrentLineBuffer;
   
       AslGbl_ErrorLog = NULL;
       AslGbl_NextError = NULL;
       AslGbl_Signature = NULL;
       AslGbl_FileType = 0;
   
       AslGbl_TotalExecutableOpcodes = 0;
       AslGbl_TotalNamedObjects = 0;
       AslGbl_TotalKeywords = 0;
       AslGbl_TotalParseNodes = 0;
       AslGbl_TotalMethods = 0;
       AslGbl_TotalAllocations = 0;
       AslGbl_TotalAllocated = 0;
       AslGbl_TotalFolds = 0;
   
       AslGbl_NextEvent = 0;
       for (i = 0; i < ASL_NUM_REPORT_LEVELS; i++)
       {
           AslGbl_ExceptionCount[i] = 0;
       }
   
       if (AcpiGbl_CaptureComments)
       {
           AslGbl_CommentState.SpacesBefore          = 0;
           AslGbl_CommentState.CommentType           = 1;
           AslGbl_CommentState.LatestParseOp         = NULL;
           AslGbl_CommentState.ParsingParenBraceNode = NULL;
           AslGbl_CommentState.CaptureComments       = TRUE;
       }
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AslDetectSourceFileType
    *
    * PARAMETERS:  Info            - Name/Handle for the file (must be open)
    *
    * RETURN:      File Type
    *
    * DESCRIPTION: Determine the type of the input file. Either binary (contains
    *              non-ASCII characters), ASL file, or an ACPI Data Table file.
    *
    ******************************************************************************/
   
   static UINT8
   AslDetectSourceFileType (
       ASL_FILE_INFO           *Info)
   {
       char                    *FileChar;
       UINT8                   Type = ASL_INPUT_TYPE_ASCII_DATA; /* default */
       ACPI_STATUS             Status;
   
   
       /* Check for 100% ASCII source file (comments are ignored) */
   
       Status = FlIsFileAsciiSource (Info->Filename, FALSE);
       if (ACPI_SUCCESS (Status))
       {
           /*
            * File contains ASCII source code. Determine if this is an ASL
            * file or an ACPI data table file.
            */
           while (fgets (AslGbl_CurrentLineBuffer, AslGbl_LineBufferSize, Info->Handle))
           {
               /* Uppercase the buffer for caseless compare */
   
               FileChar = AslGbl_CurrentLineBuffer;
               while (*FileChar)
               {
                   *FileChar = (char) toupper ((int) *FileChar);
                   FileChar++;
               }
   
               /* Presence of "DefinitionBlock" indicates actual ASL code */
   
               if (strstr (AslGbl_CurrentLineBuffer, "DEFINITIONBLOCK"))
               {
                   /* Appears to be an ASL file */
   
                   Type = ASL_INPUT_TYPE_ASCII_ASL;
                   goto Cleanup;
               }
           }
   
           /* Appears to be an ASCII data table source file */
   
           Type = ASL_INPUT_TYPE_ASCII_DATA;
           goto Cleanup;
       }
   
       /*
        * We have some sort of binary table; reopen in binary mode, then
        * check for valid ACPI table
        */
       fclose (Info->Handle);
       Info->Handle = fopen (Info->Filename, "rb");
       if (!Info->Handle)
       {
           fprintf (stderr, "Could not open input file %s\n",
               Info->Filename);
       }
   
       Status = AcValidateTableHeader (Info->Handle, 0);
       if (ACPI_SUCCESS (Status))
       {
           fprintf (stderr,
               "Binary file appears to be a valid ACPI table, disassembling\n");
   
           Type = ASL_INPUT_TYPE_BINARY_ACPI_TABLE;
           goto Cleanup;
       }
       else
       {
           fprintf (stderr,
               "Binary file does not contain a valid standard ACPI table\n");
       }
   
       Type = ASL_INPUT_TYPE_BINARY;
   
   
   Cleanup:
   
       /* Must seek back to the start of the file */
   
       fseek (Info->Handle, 0, SEEK_SET);
       return (Type);
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AslDoDisassembly
    *
    * PARAMETERS:  None
    *
    * RETURN:      Status
    *
    * DESCRIPTION: Initiate AML file disassembly. Uses ACPICA subsystem to build
    *              namespace. This function assumes that the ACPI subsystem has
    *              been initialized. The caller of the initialization will also
    *              terminate the ACPI subsystem.
    *
    ******************************************************************************/
   
   ACPI_STATUS
   AslDoDisassembly (
       void)
   {
       ACPI_STATUS             Status;
   
   
       Status = AcpiAllocateRootTable (4);
       if (ACPI_FAILURE (Status))
       {
           AcpiOsPrintf ("Could not initialize ACPI Table Manager, %s\n",
               AcpiFormatException (Status));
           return (Status);
       }
   
       /* This is where the disassembly happens */
   
       AcpiGbl_DmOpt_Disasm = TRUE;
       Status = AdAmlDisassemble (AslToFile,
           AslGbl_Files[ASL_FILE_INPUT].Filename, AslGbl_OutputFilenamePrefix,
           &AslGbl_Files[ASL_FILE_INPUT].Filename);
       if (ACPI_FAILURE (Status))
       {
           return (Status);
       }
   
       /* Check if any control methods were unresolved */
   
       AcpiDmUnresolvedWarning (0);
   
       /* Clear Error log */
   
       AeClearErrorLog ();
   
       /*
        * AslGbl_Files[ASL_FILE_INPUT].Filename was replaced with the
        * .DSL disassembly file, which can now be compiled if requested
        */
       if (AslGbl_DoCompile)
       {
           AcpiOsPrintf ("\nCompiling \"%s\"\n",
               AslGbl_Files[ASL_FILE_INPUT].Filename);
           return (AE_CTRL_CONTINUE);
       }
   
       return (AE_OK);
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AslDoOneFile
    *
    * PARAMETERS:  Filename        - Name of the file
    *
    * RETURN:      Status
    *
    * DESCRIPTION: Process a single file - either disassemble, compile, or both
    *
    ******************************************************************************/
   
   ACPI_STATUS
   AslDoOneFile (
       char                    *Filename)
   {
       ACPI_STATUS             Status;
       UINT8                   Event;
       ASL_GLOBAL_FILE_NODE    *FileNode;
   
   
       /* Re-initialize "some" compiler/preprocessor globals */
   
       AslInitializeGlobals ();
       PrInitializeGlobals ();
   
       /*
        * Extract the directory path. This path is used for possible include
        * files and the optional AML filename embedded in the input file
        * DefinitionBlock declaration.
        */
       Status = FlSplitInputPathname (Filename, &AslGbl_DirectoryPath, NULL);
       if (ACPI_FAILURE (Status))
       {
           return (Status);
       }
   
       /*
        * There was an input file detected at this point. Each input ASL file is
        * associated with one global file node consisting of the input file and
        * all output files associated with it. This is useful when compiling
        * multiple files in one command.
        */
       Status = FlInitOneFile(Filename);
       if (ACPI_FAILURE (Status))
       {
           return (AE_ERROR);
       }
   
       /* Take a copy of the input filename, convert any backslashes */
   
       AslGbl_Files[ASL_FILE_INPUT].Filename =
           UtLocalCacheCalloc (strlen (Filename) + 1);
   
       strcpy (AslGbl_Files[ASL_FILE_INPUT].Filename, Filename);
       UtConvertBackslashes (AslGbl_Files[ASL_FILE_INPUT].Filename);
   
       /*
        * Open the input file. Here, this could be an ASCII source file,
        * either an ASL file or a Data Table file, or a binary AML file
        * or binary data table file (For disassembly).
        */
       Status = FlOpenInputFile (AslGbl_Files[ASL_FILE_INPUT].Filename);
       if (ACPI_FAILURE (Status))
       {
           AePrintErrorLog (ASL_FILE_STDERR);
           return (AE_ERROR);
       }
   
       FileNode = FlGetCurrentFileNode();
   
       /* Determine input file type */
   
       AslGbl_FileType = AslDetectSourceFileType (&AslGbl_Files[ASL_FILE_INPUT]);
       FileNode->FileType = AslGbl_FileType;
       if (AslGbl_FileType == ASL_INPUT_TYPE_BINARY)
       {
           return (AE_ERROR);
       }
   
       FileNode->OriginalInputFileSize = FlGetFileSize (ASL_FILE_INPUT);
   
       /*
        * If -p not specified, we will use the input filename as the
        * output filename prefix
        */
       if (AslGbl_UseDefaultAmlFilename)
       {
           AslGbl_OutputFilenamePrefix = AslGbl_Files[ASL_FILE_INPUT].Filename;
       }
   
       /*
        * Open the output file. Note: by default, the name of this file comes from
        * the table descriptor within the input file.
        */
       if (AslGbl_FileType == ASL_INPUT_TYPE_ASCII_ASL)
       {
           Event = UtBeginEvent ("Open AML output file");
           Status = FlOpenAmlOutputFile (AslGbl_OutputFilenamePrefix);
           UtEndEvent (Event);
           if (ACPI_FAILURE (Status))
           {
               AePrintErrorLog (ASL_FILE_STDERR);
               return (AE_ERROR);
           }
       }
   
       /* Open the optional output files (listings, etc.) */
   
       Status = FlOpenMiscOutputFiles (AslGbl_OutputFilenamePrefix);
       if (ACPI_FAILURE (Status))
       {
           AePrintErrorLog (ASL_FILE_STDERR);
           return (AE_ERROR);
       }
   
       /*
        * Compilation of ASL source versus DataTable source uses different
        * compiler subsystems
        */
       switch (AslGbl_FileType)
       {
       /*
        * Data Table Compilation
        */
       case ASL_INPUT_TYPE_ASCII_DATA:
   
           Status = DtDoCompile ();
           if (ACPI_FAILURE (Status))
           {
               return (Status);
           }
   
           if (AslGbl_Signature)
           {
               AslGbl_Signature = NULL;
           }
   
           /* Check if any errors occurred during compile */
   
           Status = AslCheckForErrorExit ();
           if (ACPI_FAILURE (Status))
           {
               return (Status);
           }
   
           /* Cleanup (for next source file) and exit */
   
           AeClearErrorLog ();
           PrTerminatePreprocessor ();
           return (Status);
   
       /*
        * ASL Compilation
        */
       case ASL_INPUT_TYPE_ASCII_ASL:
   
           Status = CmDoCompile ();
           if (ACPI_FAILURE (Status))
           {
               PrTerminatePreprocessor ();
               return (Status);
           }
   
           /*
            * At this point, we know how many lines are in the input file. Save it
            * to display for post-compilation summary.
            */
           FileNode->TotalLineCount = AslGbl_CurrentLineNumber;
           return (AE_OK);
   
       /*
        * Binary ACPI table was auto-detected, disassemble it
        */
       case ASL_INPUT_TYPE_BINARY_ACPI_TABLE:
   
           /* We have what appears to be an ACPI table, disassemble it */
   
           FlCloseFile (ASL_FILE_INPUT);
           AslGbl_DoCompile = FALSE;
           AcpiGbl_DisasmFlag = TRUE;
           Status = AslDoDisassembly ();
           return (Status);
   
       /* Unknown binary table */
   
       case ASL_INPUT_TYPE_BINARY:
   
           AePrintErrorLog (ASL_FILE_STDERR);
           return (AE_ERROR);
   
       default:
   
           printf ("Unknown file type %X\n", AslGbl_FileType);
           return (AE_ERROR);
       }
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AslCheckForErrorExit
    *
    * PARAMETERS:  None. Examines global exception count array
    *
    * RETURN:      Status
    *
    * DESCRIPTION: Determine if compiler should abort with error status
    *
    ******************************************************************************/
   
   ACPI_STATUS
   AslCheckForErrorExit (
       void)
   {
   
       /*
        * Return non-zero exit code if there have been errors, unless the
        * global ignore error flag has been set
        */
       if (!AslGbl_IgnoreErrors)
       {
           if (AslGbl_ExceptionCount[ASL_ERROR] > 0)
           {
               return (AE_ERROR);
           }
   
           /* Optionally treat warnings as errors */
   
           if (AslGbl_WarningsAsErrors)
           {
               if ((AslGbl_ExceptionCount[ASL_WARNING] > 0)  ||
                   (AslGbl_ExceptionCount[ASL_WARNING2] > 0) ||
                   (AslGbl_ExceptionCount[ASL_WARNING3] > 0))
               {
                   AslError (ASL_ERROR, ASL_MSG_WARNING_AS_ERROR, NULL,
                       "(reporting warnings as errors)");
                   return (AE_ERROR);
               }
           }
       }
   
       return (AE_OK);
   }

Cache object: 2827d53dec7cb328ccc746803ea0f1df