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

     /******************************************************************************
      *
      * Module Name: aslfiles - File support functions
      *
      *****************************************************************************/
     
     /******************************************************************************
      *
      * 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/acapps.h>
   
   #define _COMPONENT          ACPI_COMPILER
           ACPI_MODULE_NAME    ("aslfiles")
   
   /* Local prototypes */
   
   static FILE *
   FlOpenIncludeWithPrefix (
       char                    *PrefixDir,
       ACPI_PARSE_OBJECT       *Op,
       char                    *Filename);
   
   static BOOLEAN
   FlInputFileExists (
       char                    *InputFilename);
   
   #ifdef ACPI_OBSOLETE_FUNCTIONS
   ACPI_STATUS
   FlParseInputPathname (
       char                    *InputFilename);
   #endif
   
   
   /*******************************************************************************
    *
    * FUNCTION:    FlInitOneFile
    *
    * PARAMETERS:  InputFilename       - The user-specified ASL source file to be
    *                                    compiled
    *
    * RETURN:      Status
    *
    * DESCRIPTION: Initialize global file structure for one input file. This file
    *              structure contains references to input, output, debugging, and
    *              other miscellaneous files that are associated for a single
    *              input ASL file.
    *
    ******************************************************************************/
   
   ACPI_STATUS
   FlInitOneFile (
       char                    *InputFilename)
   {
       UINT32                  i;
       ASL_GLOBAL_FILE_NODE    *NewFileNode;
   
   
       if (FlInputFileExists (InputFilename))
       {
           AslError (ASL_ERROR, ASL_MSG_DUPLICATE_INPUT_FILE, NULL, InputFilename);
           return (AE_ALREADY_EXISTS);
       }
   
       NewFileNode = ACPI_CAST_PTR (ASL_GLOBAL_FILE_NODE,
           UtLocalCacheCalloc (sizeof (ASL_GLOBAL_FILE_NODE)));
   
       NewFileNode->ParserErrorDetected = FALSE;
       NewFileNode->Next = AslGbl_FilesList;
   
       AslGbl_FilesList = NewFileNode;
       AslGbl_Files = NewFileNode->Files;
   
       for (i = 0; i < ASL_NUM_FILES; i++)
       {
           AslGbl_Files[i].Handle = NULL;
           AslGbl_Files[i].Filename = NULL;
       }
   
       AslGbl_Files[ASL_FILE_STDOUT].Handle   = stdout;
       AslGbl_Files[ASL_FILE_STDOUT].Filename = "STDOUT";
   
       if (AslGbl_VerboseErrors)
       {
           AslGbl_Files[ASL_FILE_STDERR].Handle = stderr;
       }
       else
       {
           AslGbl_Files[ASL_FILE_STDERR].Handle = stdout;
       }
   
       AslGbl_Files[ASL_FILE_STDERR].Filename = "STDERR";
       return (AE_OK);
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    FlInputFileExists
    *
    * PARAMETERS:  Filename       - File name to be searched
    *
    * RETURN:      Status
    *
    * DESCRIPTION: Returns true if the file name already exists.
    *
    ******************************************************************************/
   
   static BOOLEAN
   FlInputFileExists (
       char                    *Filename)
   {
       ASL_GLOBAL_FILE_NODE    *Current = AslGbl_FilesList;
   
   
       while (Current)
       {
           if (!strcmp (Filename, Current->Files[ASL_FILE_INPUT].Filename))
           {
               return (TRUE);
           }
   
           Current = Current->Next;
       }
   
       return (FALSE);
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    FlSwitchFileSet
    *
    * PARAMETERS:  Op        - Parse node for the LINE asl statement
    *
    * RETURN:      None.
    *
    * DESCRIPTION: Set the current line number
    *
    ******************************************************************************/
   
   ASL_FILE_SWITCH_STATUS
   FlSwitchFileSet (
       char                    *InputFilename)
   {
       ASL_GLOBAL_FILE_NODE    *Current = AslGbl_FilesList;
       char                    *PrevFilename = Current->Files[ASL_FILE_INPUT].Filename;
   
   
       while (Current)
       {
           if (!strcmp(Current->Files[ASL_FILE_INPUT].Filename, InputFilename))
           {
               AslGbl_Files = Current->Files;
               AslGbl_TableSignature = Current->TableSignature;
               AslGbl_TableId = Current->TableId;
   
               if (!strcmp (InputFilename, PrevFilename))
               {
                   return (SWITCH_TO_SAME_FILE);
               }
               else
               {
                   return (SWITCH_TO_DIFFERENT_FILE);
               }
           }
   
           Current = Current->Next;
       }
   
       return (FILE_NOT_FOUND);
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    FlGetFileHandle
    *
    * PARAMETERS:  OutFileId       - denotes file type of output handle
    *              InFileId        - denotes file type of the input Filename
    *              Filename
    *
    * RETURN:      File handle
    *
    * DESCRIPTION: Get the file handle for a particular filename/FileId. This
    *              function also allows the caller to specify the file Id of the
    *              desired type.
    *
    ******************************************************************************/
   
   FILE *
   FlGetFileHandle (
       UINT32                  OutFileId,
       UINT32                  InFileId,
       char                    *Filename)
   {
       ASL_GLOBAL_FILE_NODE    *Current = AslGbl_FilesList;
   
   
       if (!Filename)
       {
           return (NULL);
       }
   
       while (Current)
       {
           if (!strcmp (Current->Files[InFileId].Filename, Filename))
           {
               return (Current->Files[OutFileId].Handle);
           }
   
           Current = Current->Next;
       }
   
       return (NULL);
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    FlGetFileNode
    *
    * PARAMETERS:  FileId        - File type (ID) of the input Filename
    *              Filename      - File to search for
    *
    * RETURN:      A global file node
    *
    * DESCRIPTION: Get the file node for a particular filename/FileId.
    *
    ******************************************************************************/
   
   ASL_GLOBAL_FILE_NODE *
   FlGetFileNode (
       UINT32                  FileId,
       char                    *Filename)
   {
       ASL_GLOBAL_FILE_NODE    *Current = AslGbl_FilesList;
   
   
       if (!Filename)
       {
           return (NULL);
       }
   
       while (Current)
       {
           if (!strcmp (Current->Files[FileId].Filename, Filename))
           {
               return (Current);
           }
   
           Current = Current->Next;
       }
   
       return (NULL);
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    FlGetCurrentFileNode
    *
    * PARAMETERS:  None
    *
    * RETURN:      Global file node
    *
    * DESCRIPTION: Get the current input file node
    *
    ******************************************************************************/
   
   ASL_GLOBAL_FILE_NODE *
   FlGetCurrentFileNode (
       void)
   {
       ASL_GLOBAL_FILE_NODE    *FileNode =
           FlGetFileNode (ASL_FILE_INPUT,AslGbl_Files[ASL_FILE_INPUT].Filename);
   
   
       if (!FileNode)
       {
           /*
            * If the current file node does not exist after initializing the file
            * node structures, something went wrong and this is an unrecoverable
            * condition.
            */
           FlFileError (ASL_FILE_INPUT, ASL_MSG_COMPILER_INTERNAL);
           AslAbort ();
       }
   
       return (FileNode);
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    FlSetLineNumber
    *
    * PARAMETERS:  Op        - Parse node for the LINE asl statement
    *
    * RETURN:      None.
    *
    * DESCRIPTION: Set the current line number
    *
    ******************************************************************************/
   
   void
   FlSetLineNumber (
       UINT32                  LineNumber)
   {
   
       DbgPrint (ASL_PARSE_OUTPUT, "\n#line: New line number %u (old %u)\n",
            LineNumber, AslGbl_LogicalLineNumber);
   
       AslGbl_CurrentLineNumber = LineNumber;
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    FlSetFilename
    *
    * PARAMETERS:  Op        - Parse node for the LINE asl statement
    *
    * RETURN:      None.
    *
    * DESCRIPTION: Set the current filename
    *
    ******************************************************************************/
   
   void
   FlSetFilename (
       char                    *Filename)
   {
   
       DbgPrint (ASL_PARSE_OUTPUT, "\n#line: New filename %s (old %s)\n",
            Filename, AslGbl_Files[ASL_FILE_INPUT].Filename);
   
       /* No need to free any existing filename */
   
       AslGbl_Files[ASL_FILE_INPUT].Filename = Filename;
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    FlAddIncludeDirectory
    *
    * PARAMETERS:  Dir             - Directory pathname string
    *
    * RETURN:      None
    *
    * DESCRIPTION: Add a directory the list of include prefix directories.
    *
    ******************************************************************************/
   
   void
   FlAddIncludeDirectory (
       char                    *Dir)
   {
       ASL_INCLUDE_DIR         *NewDir;
       ASL_INCLUDE_DIR         *NextDir;
       ASL_INCLUDE_DIR         *PrevDir = NULL;
       UINT32                  NeedsSeparator = 0;
       size_t                  DirLength;
   
   
       DirLength = strlen (Dir);
       if (!DirLength)
       {
           return;
       }
   
       /* Make sure that the pathname ends with a path separator */
   
       if ((Dir[DirLength-1] != '/') &&
           (Dir[DirLength-1] != '\\'))
       {
           NeedsSeparator = 1;
       }
   
       NewDir = ACPI_CAST_PTR (ASL_INCLUDE_DIR,
           UtLocalCacheCalloc (sizeof (ASL_INCLUDE_DIR)));
       NewDir->Dir = UtLocalCacheCalloc (DirLength + 1 + NeedsSeparator);
       strcpy (NewDir->Dir, Dir);
       if (NeedsSeparator)
       {
           strcat (NewDir->Dir, "/");
       }
   
       /*
        * Preserve command line ordering of -I options by adding new elements
        * at the end of the list
        */
       NextDir = AslGbl_IncludeDirList;
       while (NextDir)
       {
           PrevDir = NextDir;
           NextDir = NextDir->Next;
       }
   
       if (PrevDir)
       {
           PrevDir->Next = NewDir;
       }
       else
       {
           AslGbl_IncludeDirList = NewDir;
       }
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    FlMergePathnames
    *
    * PARAMETERS:  PrefixDir       - Prefix directory pathname. Can be NULL or
    *                                a zero length string.
    *              FilePathname    - The include filename from the source ASL.
    *
    * RETURN:      Merged pathname string
    *
    * DESCRIPTION: Merge two pathnames that (probably) have common elements, to
    *              arrive at a minimal length string. Merge can occur if the
    *              FilePathname is relative to the PrefixDir.
    *
    ******************************************************************************/
   
   char *
   FlMergePathnames (
       char                    *PrefixDir,
       char                    *FilePathname)
   {
       char                    *CommonPath;
       char                    *Pathname;
       char                    *LastElement;
   
   
       DbgPrint (ASL_PARSE_OUTPUT, "Include: Prefix path - \"%s\"\n"
           "Include: FilePathname - \"%s\"\n",
            PrefixDir, FilePathname);
   
       /*
        * If there is no prefix directory or if the file pathname is absolute,
        * just return the original file pathname
        */
       if (!PrefixDir || (!*PrefixDir) ||
           (*FilePathname == '/') ||
            (FilePathname[1] == ':'))
       {
           Pathname = UtLocalCacheCalloc (strlen (FilePathname) + 1);
           strcpy (Pathname, FilePathname);
           goto ConvertBackslashes;
       }
   
       /* Need a local copy of the prefix directory path */
   
       CommonPath = UtLocalCacheCalloc (strlen (PrefixDir) + 1);
       strcpy (CommonPath, PrefixDir);
   
       /*
        * Walk forward through the file path, and simultaneously backward
        * through the prefix directory path until there are no more
        * relative references at the start of the file path.
        */
       while (*FilePathname && (!strncmp (FilePathname, "../", 3)))
       {
           /* Remove last element of the prefix directory path */
   
           LastElement = strrchr (CommonPath, '/');
           if (!LastElement)
           {
               goto ConcatenatePaths;
           }
   
           *LastElement = 0;   /* Terminate CommonPath string */
           FilePathname += 3;  /* Point to next path element */
       }
   
       /*
        * Remove the last element of the prefix directory path (it is the same as
        * the first element of the file pathname), and build the final merged
        * pathname.
        */
       LastElement = strrchr (CommonPath, '/');
       if (LastElement)
       {
           *LastElement = 0;
       }
   
       /* Build the final merged pathname */
   
   ConcatenatePaths:
       Pathname = UtLocalCacheCalloc (
           strlen (CommonPath) + strlen (FilePathname) + 2);
       if (LastElement && *CommonPath)
       {
           strcpy (Pathname, CommonPath);
           strcat (Pathname, "/");
       }
       strcat (Pathname, FilePathname);
   
       /* Convert all backslashes to normal slashes */
   
   ConvertBackslashes:
       UtConvertBackslashes (Pathname);
   
       DbgPrint (ASL_PARSE_OUTPUT, "Include: Merged Pathname - \"%s\"\n",
            Pathname);
       return (Pathname);
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    FlOpenIncludeWithPrefix
    *
    * PARAMETERS:  PrefixDir       - Prefix directory pathname. Can be a zero
    *                                length string.
    *              Filename        - The include filename from the source ASL.
    *
    * RETURN:      Valid file descriptor if successful. Null otherwise.
    *
    * DESCRIPTION: Open an include file and push it on the input file stack.
    *
    ******************************************************************************/
   
   static FILE *
   FlOpenIncludeWithPrefix (
       char                    *PrefixDir,
       ACPI_PARSE_OBJECT       *Op,
       char                    *Filename)
   {
       FILE                    *IncludeFile;
       char                    *Pathname;
       UINT32                  OriginalLineNumber;
   
   
       /* Build the full pathname to the file */
   
       Pathname = FlMergePathnames (PrefixDir, Filename);
   
       DbgPrint (ASL_PARSE_OUTPUT, "Include: Opening file - \"%s\"\n\n",
           Pathname);
   
       /* Attempt to open the file, push if successful */
   
       IncludeFile = fopen (Pathname, "r");
       if (!IncludeFile)
       {
           return (NULL);
       }
   
       /*
        * Check the entire include file for any # preprocessor directives.
        * This is because there may be some confusion between the #include
        * preprocessor directive and the ASL Include statement. A file included
        * by the ASL include cannot contain preprocessor directives because
        * the preprocessor has already run by the time the ASL include is
        * recognized (by the compiler, not the preprocessor.)
        *
        * Note: DtGetNextLine strips/ignores comments.
        * Save current line number since DtGetNextLine modifies it.
        */
       AslGbl_CurrentLineNumber--;
       OriginalLineNumber = AslGbl_CurrentLineNumber;
   
       while (DtGetNextLine (IncludeFile, DT_ALLOW_MULTILINE_QUOTES) != ASL_EOF)
       {
           if (AslGbl_CurrentLineBuffer[0] == '#')
           {
               AslError (ASL_ERROR, ASL_MSG_INCLUDE_FILE,
                   Op, "use #include instead");
           }
       }
   
       AslGbl_CurrentLineNumber = OriginalLineNumber;
   
       /* Must seek back to the start of the file */
   
       fseek (IncludeFile, 0, SEEK_SET);
   
       /* Push the include file on the open input file stack */
   
       AslPushInputFileStack (IncludeFile, Pathname);
       return (IncludeFile);
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    FlOpenIncludeFile
    *
    * PARAMETERS:  Op        - Parse node for the INCLUDE ASL statement
    *
    * RETURN:      None.
    *
    * DESCRIPTION: Open an include file and push it on the input file stack.
    *
    ******************************************************************************/
   
   void
   FlOpenIncludeFile (
       ACPI_PARSE_OBJECT       *Op)
   {
       FILE                    *IncludeFile;
       ASL_INCLUDE_DIR         *NextDir;
   
   
       /* Op must be valid */
   
       if (!Op)
       {
           AslCommonError (ASL_ERROR, ASL_MSG_INCLUDE_FILE_OPEN,
               AslGbl_CurrentLineNumber, AslGbl_LogicalLineNumber,
               AslGbl_InputByteCount, AslGbl_CurrentColumn,
               AslGbl_Files[ASL_FILE_INPUT].Filename, " - Null parse node");
   
           return;
       }
   
       /*
        * Flush out the "include ()" statement on this line, start
        * the actual include file on the next line
        */
       AslResetCurrentLineBuffer ();
       FlPrintFile (ASL_FILE_SOURCE_OUTPUT, "\n");
       AslGbl_CurrentLineOffset++;
   
   
       /* Attempt to open the include file */
   
       /* If the file specifies an absolute path, just open it */
   
       if ((Op->Asl.Value.String[0] == '/')  ||
           (Op->Asl.Value.String[0] == '\\') ||
           (Op->Asl.Value.String[1] == ':'))
       {
           IncludeFile = FlOpenIncludeWithPrefix ("", Op, Op->Asl.Value.String);
           if (!IncludeFile)
           {
               goto ErrorExit;
           }
           return;
       }
   
       /*
        * The include filename is not an absolute path.
        *
        * First, search for the file within the "local" directory -- meaning
        * the same directory that contains the source file.
        *
        * Construct the file pathname from the global directory name.
        */
       IncludeFile = FlOpenIncludeWithPrefix (
           AslGbl_DirectoryPath, Op, Op->Asl.Value.String);
       if (IncludeFile)
       {
           return;
       }
   
       /*
        * Second, search for the file within the (possibly multiple) directories
        * specified by the -I option on the command line.
        */
       NextDir = AslGbl_IncludeDirList;
       while (NextDir)
       {
           IncludeFile = FlOpenIncludeWithPrefix (
               NextDir->Dir, Op, Op->Asl.Value.String);
           if (IncludeFile)
           {
               return;
           }
   
           NextDir = NextDir->Next;
       }
   
       /* We could not open the include file after trying very hard */
   
   ErrorExit:
       sprintf (AslGbl_MsgBuffer, "%s, %s", Op->Asl.Value.String, strerror (errno));
       AslError (ASL_ERROR, ASL_MSG_INCLUDE_FILE_OPEN, Op, AslGbl_MsgBuffer);
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    FlOpenInputFile
    *
    * PARAMETERS:  InputFilename       - The user-specified ASL source file to be
    *                                    compiled
    *
    * RETURN:      Status
    *
    * DESCRIPTION: Open the specified input file, and save the directory path to
    *              the file so that include files can be opened in the same
    *              directory. NOTE: File is opened in text mode.
    *
    ******************************************************************************/
   
   ACPI_STATUS
   FlOpenInputFile (
       char                    *InputFilename)
   {
   
       /* Open the input ASL file, text mode */
   
       FlOpenFile (ASL_FILE_INPUT, InputFilename, "rt");
       AslCompilerin = AslGbl_Files[ASL_FILE_INPUT].Handle;
   
       return (AE_OK);
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    FlOpenAmlOutputFile
    *
    * PARAMETERS:  FilenamePrefix       - The user-specified ASL source file
    *
    * RETURN:      Status
    *
    * DESCRIPTION: Create the output filename (*.AML) and open the file. The file
    *              is created in the same directory as the parent input file.
    *
    ******************************************************************************/
   
   ACPI_STATUS
   FlOpenAmlOutputFile (
       char                    *FilenamePrefix)
   {
       char                    *Filename;
   
   
       /* Output filename usually comes from the ASL itself */
   
       Filename = AslGbl_Files[ASL_FILE_AML_OUTPUT].Filename;
       if (!Filename)
       {
           /* Create the output AML filename */
           if (!AcpiGbl_CaptureComments)
           {
               Filename = FlGenerateFilename (FilenamePrefix, FILE_SUFFIX_AML_CODE);
           }
           else
           {
               Filename = FlGenerateFilename (FilenamePrefix, FILE_SUFFIX_CONVERT_AML);
           }
           if (!Filename)
           {
               AslCommonError (ASL_ERROR, ASL_MSG_OUTPUT_FILENAME,
                   0, 0, 0, 0, NULL, NULL);
               return (AE_ERROR);
           }
   
           AslGbl_Files[ASL_FILE_AML_OUTPUT].Filename = Filename;
       }
   
       /* Open the output AML file in binary mode */
   
       FlOpenFile (ASL_FILE_AML_OUTPUT, Filename, "w+b");
       return (AE_OK);
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    FlOpenMiscOutputFiles
    *
    * PARAMETERS:  FilenamePrefix       - The user-specified ASL source file
    *
    * RETURN:      Status
    *
    * DESCRIPTION: Create and open the various output files needed, depending on
    *              the command line options
    *
    ******************************************************************************/
   
   ACPI_STATUS
   FlOpenMiscOutputFiles (
       char                    *FilenamePrefix)
   {
       char                    *Filename;
   
   
        /* Create/Open a map file if requested */
   
       if (AslGbl_MapfileFlag)
       {
           Filename = FlGenerateFilename (FilenamePrefix, FILE_SUFFIX_MAP);
           if (!Filename)
           {
               AslCommonError (ASL_ERROR, ASL_MSG_LISTING_FILENAME,
                   0, 0, 0, 0, NULL, NULL);
               return (AE_ERROR);
           }
   
           /* Open the hex file, text mode (closed at compiler exit) */
   
           FlOpenFile (ASL_FILE_MAP_OUTPUT, Filename, "w+t");
   
           AslCompilerSignon (ASL_FILE_MAP_OUTPUT);
           AslCompilerFileHeader (ASL_FILE_MAP_OUTPUT);
       }
   
       /* All done for disassembler */
   
       if (AslGbl_FileType == ASL_INPUT_TYPE_BINARY_ACPI_TABLE)
       {
           return (AE_OK);
       }
   
       /* Create/Open a hex output file if asked */
   
       if (AslGbl_HexOutputFlag)
       {
           Filename = FlGenerateFilename (FilenamePrefix, FILE_SUFFIX_HEX_DUMP);
           if (!Filename)
           {
               AslCommonError (ASL_ERROR, ASL_MSG_LISTING_FILENAME,
                   0, 0, 0, 0, NULL, NULL);
               return (AE_ERROR);
           }
   
           /* Open the hex file, text mode */
   
           FlOpenFile (ASL_FILE_HEX_OUTPUT, Filename, "w+t");
   
           AslCompilerSignon (ASL_FILE_HEX_OUTPUT);
           AslCompilerFileHeader (ASL_FILE_HEX_OUTPUT);
       }
   
       /* Create/Open a debug output file if asked */
   
       if (AslGbl_DebugFlag)
       {
           Filename = FlGenerateFilename (FilenamePrefix, FILE_SUFFIX_DEBUG);
           if (!Filename)
           {
               AslCommonError (ASL_ERROR, ASL_MSG_DEBUG_FILENAME,
                   0, 0, 0, 0, NULL, NULL);
               return (AE_ERROR);
           }
   
           /* Open the debug file as STDERR, text mode */
   
           AslGbl_Files[ASL_FILE_DEBUG_OUTPUT].Filename = Filename;
           AslGbl_Files[ASL_FILE_DEBUG_OUTPUT].Handle =
               freopen (Filename, "w+t", stderr);
   
           if (!AslGbl_Files[ASL_FILE_DEBUG_OUTPUT].Handle)
           {
               /*
                * A problem with freopen is that on error, we no longer
                * have stderr and cannot emit normal error messages.
                * Emit error to stdout, close files, and exit.
                */
              fprintf (stdout,
                  "\nCould not open debug output file: %s\n\n", Filename);
  
              CmCleanupAndExit ();
              exit (1);
          }
  
          AslCompilerSignon (ASL_FILE_DEBUG_OUTPUT);
          AslCompilerFileHeader (ASL_FILE_DEBUG_OUTPUT);
      }
  
      /* Create/Open a cross-reference output file if asked */
  
      if (AslGbl_CrossReferenceOutput)
      {
          Filename = FlGenerateFilename (FilenamePrefix, FILE_SUFFIX_XREF);
          if (!Filename)
          {
              AslCommonError (ASL_ERROR, ASL_MSG_DEBUG_FILENAME,
                  0, 0, 0, 0, NULL, NULL);
              return (AE_ERROR);
          }
  
          FlOpenFile (ASL_FILE_XREF_OUTPUT, Filename, "w+t");
  
          AslCompilerSignon (ASL_FILE_XREF_OUTPUT);
          AslCompilerFileHeader (ASL_FILE_XREF_OUTPUT);
      }
  
      /* Create/Open a listing output file if asked */
  
      if (AslGbl_ListingFlag)
      {
          Filename = FlGenerateFilename (FilenamePrefix, FILE_SUFFIX_LISTING);
          if (!Filename)
          {
              AslCommonError (ASL_ERROR, ASL_MSG_LISTING_FILENAME,
                  0, 0, 0, 0, NULL, NULL);
              return (AE_ERROR);
          }
  
          /* Open the listing file, text mode */
  
          FlOpenFile (ASL_FILE_LISTING_OUTPUT, Filename, "w+t");
  
          AslCompilerSignon (ASL_FILE_LISTING_OUTPUT);
          AslCompilerFileHeader (ASL_FILE_LISTING_OUTPUT);
      }
  
      /* Create the preprocessor output temp file if preprocessor enabled */
  
      if (AslGbl_PreprocessFlag)
      {
          Filename = FlGenerateFilename (FilenamePrefix, FILE_SUFFIX_PREPROCESSOR);
          if (!Filename)
          {
              AslCommonError (ASL_ERROR, ASL_MSG_PREPROCESSOR_FILENAME,
                  0, 0, 0, 0, NULL, NULL);
              return (AE_ERROR);
          }
  
          FlOpenFile (ASL_FILE_PREPROCESSOR, Filename, "w+t");
      }
  
      /*
       * Create the "user" preprocessor output file if -li flag set.
       * Note, this file contains no embedded #line directives.
       */
      if (AslGbl_PreprocessorOutputFlag)
      {
          Filename = FlGenerateFilename (FilenamePrefix, FILE_SUFFIX_PREPROC_USER);
          if (!Filename)
          {
              AslCommonError (ASL_ERROR, ASL_MSG_PREPROCESSOR_FILENAME,
                  0, 0, 0, 0, NULL, NULL);
              return (AE_ERROR);
          }
  
          FlOpenFile (ASL_FILE_PREPROCESSOR_USER, Filename, "w+t");
      }
  
      /* All done for data table compiler */
  
      if (AslGbl_FileType == ASL_INPUT_TYPE_ASCII_DATA)
      {
          return (AE_OK);
      }
  
      /* Create/Open a combined source output file */
  
      Filename = FlGenerateFilename (FilenamePrefix, FILE_SUFFIX_SOURCE);
      if (!Filename)
      {
          AslCommonError (ASL_ERROR, ASL_MSG_LISTING_FILENAME,
              0, 0, 0, 0, NULL, NULL);
          return (AE_ERROR);
      }
  
      /*
       * Open the source output file, binary mode (so that LF does not get
       * expanded to CR/LF on some systems, messing up our seek
       * calculations.)
       */
      FlOpenFile (ASL_FILE_SOURCE_OUTPUT, Filename, "w+b");
  
  /*
  // TBD: TEMP
  //    AslCompilerin = AslGbl_Files[ASL_FILE_SOURCE_OUTPUT].Handle;
  */
      /* Create/Open a assembly code source output file if asked */
  
      if (AslGbl_AsmOutputFlag)
      {
          Filename = FlGenerateFilename (FilenamePrefix, FILE_SUFFIX_ASM_SOURCE);
          if (!Filename)
          {
              AslCommonError (ASL_ERROR, ASL_MSG_LISTING_FILENAME,
                  0, 0, 0, 0, NULL, NULL);
              return (AE_ERROR);
          }
  
          /* Open the assembly code source file, text mode */
  
          FlOpenFile (ASL_FILE_ASM_SOURCE_OUTPUT, Filename, "w+t");
  
          AslCompilerSignon (ASL_FILE_ASM_SOURCE_OUTPUT);
          AslCompilerFileHeader (ASL_FILE_ASM_SOURCE_OUTPUT);
      }
  
      /* Create/Open a C code source output file if asked */
  
      if (AslGbl_C_OutputFlag)
      {
          Filename = FlGenerateFilename (FilenamePrefix, FILE_SUFFIX_C_SOURCE);
          if (!Filename)
          {
              AslCommonError (ASL_ERROR, ASL_MSG_LISTING_FILENAME,
                  0, 0, 0, 0, NULL, NULL);
              return (AE_ERROR);
          }
  
          /* Open the C code source file, text mode */
  
          FlOpenFile (ASL_FILE_C_SOURCE_OUTPUT, Filename, "w+t");
  
          FlPrintFile (ASL_FILE_C_SOURCE_OUTPUT, "/*\n");
          AslCompilerSignon (ASL_FILE_C_SOURCE_OUTPUT);
          AslCompilerFileHeader (ASL_FILE_C_SOURCE_OUTPUT);
      }
  
      /* Create/Open a C code source output file for the offset table if asked */
  
      if (AslGbl_C_OffsetTableFlag)
      {
          Filename = FlGenerateFilename (FilenamePrefix, FILE_SUFFIX_C_OFFSET);
          if (!Filename)
          {
              AslCommonError (ASL_ERROR, ASL_MSG_LISTING_FILENAME,
                  0, 0, 0, 0, NULL, NULL);
              return (AE_ERROR);
          }
  
          /* Open the C code source file, text mode */
  
          FlOpenFile (ASL_FILE_C_OFFSET_OUTPUT, Filename, "w+t");
  
          FlPrintFile (ASL_FILE_C_OFFSET_OUTPUT, "/*\n");
          AslCompilerSignon (ASL_FILE_C_OFFSET_OUTPUT);
          AslCompilerFileHeader (ASL_FILE_C_OFFSET_OUTPUT);
      }
  
      /* Create/Open a assembly include output file if asked */
  
      if (AslGbl_AsmIncludeOutputFlag)
      {
          Filename = FlGenerateFilename (FilenamePrefix, FILE_SUFFIX_ASM_INCLUDE);
          if (!Filename)
          {
              AslCommonError (ASL_ERROR, ASL_MSG_LISTING_FILENAME,
                  0, 0, 0, 0, NULL, NULL);
              return (AE_ERROR);
          }
  
          /* Open the assembly include file, text mode */
  
          FlOpenFile (ASL_FILE_ASM_INCLUDE_OUTPUT, Filename, "w+t");
  
          AslCompilerSignon (ASL_FILE_ASM_INCLUDE_OUTPUT);
          AslCompilerFileHeader (ASL_FILE_ASM_INCLUDE_OUTPUT);
      }
  
      /* Create/Open a C include output file if asked */
  
      if (AslGbl_C_IncludeOutputFlag)
      {
          Filename = FlGenerateFilename (FilenamePrefix, FILE_SUFFIX_C_INCLUDE);
          if (!Filename)
          {
              AslCommonError (ASL_ERROR, ASL_MSG_LISTING_FILENAME,
                  0, 0, 0, 0, NULL, NULL);
              return (AE_ERROR);
          }
  
          /* Open the C include file, text mode */
  
          FlOpenFile (ASL_FILE_C_INCLUDE_OUTPUT, Filename, "w+t");
  
          FlPrintFile (ASL_FILE_C_INCLUDE_OUTPUT, "/*\n");
          AslCompilerSignon (ASL_FILE_C_INCLUDE_OUTPUT);
          AslCompilerFileHeader (ASL_FILE_C_INCLUDE_OUTPUT);
      }
  
      /* Create a namespace output file if asked */
  
      if (AslGbl_NsOutputFlag)
      {
          Filename = FlGenerateFilename (FilenamePrefix, FILE_SUFFIX_NAMESPACE);
          if (!Filename)
          {
              AslCommonError (ASL_ERROR, ASL_MSG_LISTING_FILENAME,
                  0, 0, 0, 0, NULL, NULL);
              return (AE_ERROR);
          }
  
          /* Open the namespace file, text mode */
  
          FlOpenFile (ASL_FILE_NAMESPACE_OUTPUT, Filename, "w+t");
  
          AslCompilerSignon (ASL_FILE_NAMESPACE_OUTPUT);
          AslCompilerFileHeader (ASL_FILE_NAMESPACE_OUTPUT);
      }
  
      /* Create a debug file for the converter */
  
      if (AcpiGbl_DebugAslConversion)
      {
          Filename = FlGenerateFilename (FilenamePrefix, FILE_SUFFIX_CONVERT_DEBUG);
          if (!Filename)
          {
              AslCommonError (ASL_ERROR, ASL_MSG_LISTING_FILENAME,
                  0, 0, 0, 0, NULL, NULL);
              return (AE_ERROR);
          }
  
          /* Open the converter debug file, text mode */
  
          FlOpenFile (ASL_FILE_CONV_DEBUG_OUTPUT, Filename, "w+t");
  
          AslCompilerSignon (ASL_FILE_CONV_DEBUG_OUTPUT);
          AslCompilerFileHeader (ASL_FILE_CONV_DEBUG_OUTPUT);
  
          AcpiGbl_ConvDebugFile = AslGbl_Files[ASL_FILE_CONV_DEBUG_OUTPUT].Handle;
      }
  
      return (AE_OK);
  }
  
  
  #ifdef ACPI_OBSOLETE_FUNCTIONS
  /*******************************************************************************
   *
   * FUNCTION:    FlParseInputPathname
   *
   * PARAMETERS:  InputFilename       - The user-specified ASL source file to be
   *                                    compiled
   *
   * RETURN:      Status
   *
   * DESCRIPTION: Split the input path into a directory and filename part
   *              1) Directory part used to open include files
   *              2) Filename part used to generate output filenames
   *
   ******************************************************************************/
  
  ACPI_STATUS
  FlParseInputPathname (
      char                    *InputFilename)
  {
      char                    *Substring;
  
  
      if (!InputFilename)
      {
          return (AE_OK);
      }
  
      /* Get the path to the input filename's directory */
  
      AslGbl_DirectoryPath = strdup (InputFilename);
      if (!AslGbl_DirectoryPath)
      {
          return (AE_NO_MEMORY);
      }
  
      Substring = strrchr (AslGbl_DirectoryPath, '\\');
      if (!Substring)
      {
          Substring = strrchr (AslGbl_DirectoryPath, '/');
          if (!Substring)
          {
              Substring = strrchr (AslGbl_DirectoryPath, ':');
          }
      }
  
      if (!Substring)
      {
          AslGbl_DirectoryPath[0] = 0;
          if (AslGbl_UseDefaultAmlFilename)
          {
              AslGbl_OutputFilenamePrefix = strdup (InputFilename);
          }
      }
      else
      {
          if (AslGbl_UseDefaultAmlFilename)
          {
              AslGbl_OutputFilenamePrefix = strdup (Substring + 1);
          }
          *(Substring+1) = 0;
      }
  
      UtConvertBackslashes (AslGbl_OutputFilenamePrefix);
      return (AE_OK);
  }
  #endif

Cache object: 432a9fef386bfa85afb6da5bf14689fb