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

     /******************************************************************************
      *
      * Module Name: aslfileio - File I/O support
      *
      *****************************************************************************/
     
     /******************************************************************************
      *
      * 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    ("aslfileio")
   
   
   /*******************************************************************************
    *
    * FUNCTION:    FlFileError
    *
    * PARAMETERS:  FileId              - Index into file info array
    *              ErrorId             - Index into error message array
    *
    * RETURN:      None
    *
    * DESCRIPTION: Decode errno to an error message and add the entire error
    *              to the error log.
    *
    ******************************************************************************/
   
   void
   FlFileError (
       UINT32                  FileId,
       UINT8                   ErrorId)
   {
   
       sprintf (AslGbl_MsgBuffer, "\"%s\" (%s) - %s", AslGbl_Files[FileId].Filename,
           AslGbl_FileDescs[FileId].Description, strerror (errno));
   
       AslCommonError (ASL_ERROR, ErrorId, 0, 0, 0, 0, NULL, AslGbl_MsgBuffer);
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    FlOpenFile
    *
    * PARAMETERS:  FileId              - Index into file info array
    *              Filename            - file pathname to open
    *              Mode                - Open mode for fopen
    *
    * RETURN:      None
    *
    * DESCRIPTION: Open a file.
    *              NOTE: Aborts compiler on any error.
    *
    ******************************************************************************/
   
   void
   FlOpenFile (
       UINT32                  FileId,
       char                    *Filename,
       char                    *Mode)
   {
       FILE                    *File;
   
   
       AslGbl_Files[FileId].Filename = Filename;
       AslGbl_Files[FileId].Handle = NULL;
   
       File = fopen (Filename, Mode);
       if (!File)
       {
           FlFileError (FileId, ASL_MSG_OPEN);
           AslAbort ();
       }
   
       AslGbl_Files[FileId].Handle = File;
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    FlGetFileSize
    *
    * PARAMETERS:  FileId              - Index into file info array
    *
    * RETURN:      File Size
    *
    * DESCRIPTION: Get current file size. Uses common seek-to-EOF function.
    *              File must be open. Aborts compiler on error.
    *
    ******************************************************************************/
   
   UINT32
   FlGetFileSize (
       UINT32                  FileId)
   {
       UINT32                  FileSize;
   
   
       FileSize = CmGetFileSize (AslGbl_Files[FileId].Handle);
       if (FileSize == ACPI_UINT32_MAX)
       {
           AslAbort();
       }
   
       return (FileSize);
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    FlReadFile
    *
    * PARAMETERS:  FileId              - Index into file info array
    *              Buffer              - Where to place the data
    *              Length              - Amount to read
    *
    * RETURN:      Status. AE_ERROR indicates EOF.
    *
    * DESCRIPTION: Read data from an open file.
    *              NOTE: Aborts compiler on any error.
    *
    ******************************************************************************/
   
   ACPI_STATUS
   FlReadFile (
       UINT32                  FileId,
       void                    *Buffer,
       UINT32                  Length)
   {
       UINT32                  Actual;
   
   
       /* Read and check for error */
   
       Actual = fread (Buffer, 1, Length, AslGbl_Files[FileId].Handle);
       if (Actual < Length)
       {
           if (feof (AslGbl_Files[FileId].Handle))
           {
               /* End-of-file, just return error */
   
               return (AE_ERROR);
           }
   
           FlFileError (FileId, ASL_MSG_READ);
           AslAbort ();
       }
   
       return (AE_OK);
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    FlWriteFile
    *
    * PARAMETERS:  FileId              - Index into file info array
    *              Buffer              - Data to write
    *              Length              - Amount of data to write
    *
    * RETURN:      None
    *
    * DESCRIPTION: Write data to an open file.
    *              NOTE: Aborts compiler on any error.
    *
    ******************************************************************************/
   
   void
   FlWriteFile (
       UINT32                  FileId,
       void                    *Buffer,
       UINT32                  Length)
   {
       UINT32                  Actual;
   
   
       /* Write and check for error */
   
       Actual = fwrite ((char *) Buffer, 1, Length, AslGbl_Files[FileId].Handle);
       if (Actual != Length)
       {
           FlFileError (FileId, ASL_MSG_WRITE);
           AslAbort ();
       }
   
       if ((FileId == ASL_FILE_PREPROCESSOR) && AslGbl_PreprocessorOutputFlag)
       {
           /* Duplicate the output to the user preprocessor (.i) file */
   
           Actual = fwrite ((char *) Buffer, 1, Length,
               AslGbl_Files[ASL_FILE_PREPROCESSOR_USER].Handle);
           if (Actual != Length)
           {
               FlFileError (FileId, ASL_MSG_WRITE);
               AslAbort ();
           }
       }
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    FlPrintFile
    *
    * PARAMETERS:  FileId              - Index into file info array
    *              Format              - Printf format string
    *              ...                 - Printf arguments
    *
    * RETURN:      None
    *
    * DESCRIPTION: Formatted write to an open file.
    *              NOTE: Aborts compiler on any error.
    *
    ******************************************************************************/
   
   void
   FlPrintFile (
       UINT32                  FileId,
       char                    *Format,
       ...)
   {
       INT32                   Actual;
       va_list                 Args;
   
   
       va_start (Args, Format);
       Actual = vfprintf (AslGbl_Files[FileId].Handle, Format, Args);
       va_end (Args);
   
       if (Actual == -1)
       {
           FlFileError (FileId, ASL_MSG_WRITE);
           AslAbort ();
       }
   
       if ((FileId == ASL_FILE_PREPROCESSOR) &&
           AslGbl_PreprocessorOutputFlag)
       {
           /*
            * Duplicate the output to the user preprocessor (.i) file,
            * except: no #line directives.
            */
           if (!strncmp (Format, "#line", 5))
           {
               return;
           }
   
           va_start (Args, Format);
           Actual = vfprintf (AslGbl_Files[ASL_FILE_PREPROCESSOR_USER].Handle,
               Format, Args);
           va_end (Args);
   
           if (Actual == -1)
           {
               FlFileError (FileId, ASL_MSG_WRITE);
               AslAbort ();
           }
       }
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    FlSeekFile
    *
    * PARAMETERS:  FileId              - Index into file info array
    *              Offset              - Absolute byte offset in file
    *
    * RETURN:      None
    *
    * DESCRIPTION: Seek to absolute offset.
    *              NOTE: Aborts compiler on any error.
    *
    ******************************************************************************/
   
   void
   FlSeekFile (
       UINT32                  FileId,
       long                    Offset)
   {
       int                     Error;
   
   
       Error = fseek (AslGbl_Files[FileId].Handle, Offset, SEEK_SET);
       if (Error)
       {
           FlFileError (FileId, ASL_MSG_SEEK);
           AslAbort ();
       }
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    FlCloseFile
    *
    * PARAMETERS:  FileId              - Index into file info array
    *
    * RETURN:      None
    *
    * DESCRIPTION: Close an open file. Aborts compiler on error
    *
    ******************************************************************************/
   
   void
   FlCloseFile (
       UINT32                  FileId)
   {
       int                     Error;
   
   
       if (!AslGbl_Files[FileId].Handle)
       {
           return;
       }
   
       Error = fclose (AslGbl_Files[FileId].Handle);
       if (Error)
       {
           FlFileError (FileId, ASL_MSG_CLOSE);
           AslAbort ();
       }
   
       /* Do not clear/free the filename string */
   
       AslGbl_Files[FileId].Handle = NULL;
       return;
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    FlDeleteFile
    *
    * PARAMETERS:  FileId              - Index into file info array
    *
    * RETURN:      None
    *
    * DESCRIPTION: Delete a file.
    *
    ******************************************************************************/
   
   void
   FlDeleteFile (
       UINT32                  FileId)
   {
       ASL_FILE_INFO           *Info = &AslGbl_Files[FileId];
   
   
       if (!Info->Filename)
       {
           return;
       }
   
       if (remove (Info->Filename))
       {
           printf ("%s (%s file) ",
               Info->Filename, AslGbl_FileDescs[FileId].Description);
           perror ("Could not delete");
       }
   
       Info->Filename = NULL;
       return;
   }

Cache object: c4cf1d9c0b2e3e76413b5b28b4c4233b