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

   1 /******************************************************************************
   2  *
   3  * Module Name: aslfileio - File I/O support
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2018, 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 #include "aslcompiler.h"
 153 #include "acapps.h"
 154
 155 #define _COMPONENT          ACPI_COMPILER
 156         ACPI_MODULE_NAME    ("aslfileio")
 157
 158
 159 /*******************************************************************************
 160  *
 161  * FUNCTION:    FlFileError
 162  *
 163  * PARAMETERS:  FileId              - Index into file info array
 164  *              ErrorId             - Index into error message array
 165  *
 166  * RETURN:      None
 167  *
 168  * DESCRIPTION: Decode errno to an error message and add the entire error
 169  *              to the error log.
 170  *
 171  ******************************************************************************/
 172
 173 void
 174 FlFileError (
 175     UINT32                  FileId,
 176     UINT8                   ErrorId)
 177 {
 178
 179     sprintf (AslGbl_MsgBuffer, "\"%s\" (%s) - %s", AslGbl_Files[FileId].Filename,
 180         AslGbl_Files[FileId].Description, strerror (errno));
 181
 182     AslCommonError (ASL_ERROR, ErrorId, 0, 0, 0, 0, NULL, AslGbl_MsgBuffer);
 183 }
 184
 185
 186 /*******************************************************************************
 187  *
 188  * FUNCTION:    FlOpenFile
 189  *
 190  * PARAMETERS:  FileId              - Index into file info array
 191  *              Filename            - file pathname to open
 192  *              Mode                - Open mode for fopen
 193  *
 194  * RETURN:      None
 195  *
 196  * DESCRIPTION: Open a file.
 197  *              NOTE: Aborts compiler on any error.
 198  *
 199  ******************************************************************************/
 200
 201 void
 202 FlOpenFile (
 203     UINT32                  FileId,
 204     char                    *Filename,
 205     char                    *Mode)
 206 {
 207     FILE                    *File;
 208
 209
 210     AslGbl_Files[FileId].Filename = Filename;
 211     AslGbl_Files[FileId].Handle = NULL;
 212
 213     File = fopen (Filename, Mode);
 214     if (!File)
 215     {
 216         FlFileError (FileId, ASL_MSG_OPEN);
 217         AslAbort ();
 218     }
 219
 220     AslGbl_Files[FileId].Handle = File;
 221 }
 222
 223
 224 /*******************************************************************************
 225  *
 226  * FUNCTION:    FlGetFileSize
 227  *
 228  * PARAMETERS:  FileId              - Index into file info array
 229  *
 230  * RETURN:      File Size
 231  *
 232  * DESCRIPTION: Get current file size. Uses common seek-to-EOF function.
 233  *              File must be open. Aborts compiler on error.
 234  *
 235  ******************************************************************************/
 236
 237 UINT32
 238 FlGetFileSize (
 239     UINT32                  FileId)
 240 {
 241     UINT32                  FileSize;
 242
 243
 244     FileSize = CmGetFileSize (AslGbl_Files[FileId].Handle);
 245     if (FileSize == ACPI_UINT32_MAX)
 246     {
 247         AslAbort();
 248     }
 249
 250     return (FileSize);
 251 }
 252
 253
 254 /*******************************************************************************
 255  *
 256  * FUNCTION:    FlReadFile
 257  *
 258  * PARAMETERS:  FileId              - Index into file info array
 259  *              Buffer              - Where to place the data
 260  *              Length              - Amount to read
 261  *
 262  * RETURN:      Status. AE_ERROR indicates EOF.
 263  *
 264  * DESCRIPTION: Read data from an open file.
 265  *              NOTE: Aborts compiler on any error.
 266  *
 267  ******************************************************************************/
 268
 269 ACPI_STATUS
 270 FlReadFile (
 271     UINT32                  FileId,
 272     void                    *Buffer,
 273     UINT32                  Length)
 274 {
 275     UINT32                  Actual;
 276
 277
 278     /* Read and check for error */
 279
 280     Actual = fread (Buffer, 1, Length, AslGbl_Files[FileId].Handle);
 281     if (Actual < Length)
 282     {
 283         if (feof (AslGbl_Files[FileId].Handle))
 284         {
 285             /* End-of-file, just return error */
 286
 287             return (AE_ERROR);
 288         }
 289
 290         FlFileError (FileId, ASL_MSG_READ);
 291         AslAbort ();
 292     }
 293
 294     return (AE_OK);
 295 }
 296
 297
 298 /*******************************************************************************
 299  *
 300  * FUNCTION:    FlWriteFile
 301  *
 302  * PARAMETERS:  FileId              - Index into file info array
 303  *              Buffer              - Data to write
 304  *              Length              - Amount of data to write
 305  *
 306  * RETURN:      None
 307  *
 308  * DESCRIPTION: Write data to an open file.
 309  *              NOTE: Aborts compiler on any error.
 310  *
 311  ******************************************************************************/
 312
 313 void
 314 FlWriteFile (
 315     UINT32                  FileId,
 316     void                    *Buffer,
 317     UINT32                  Length)
 318 {
 319     UINT32                  Actual;
 320
 321
 322     /* Write and check for error */
 323
 324     Actual = fwrite ((char *) Buffer, 1, Length, AslGbl_Files[FileId].Handle);
 325     if (Actual != Length)
 326     {
 327         FlFileError (FileId, ASL_MSG_WRITE);
 328         AslAbort ();
 329     }
 330
 331     if ((FileId == ASL_FILE_PREPROCESSOR) && AslGbl_PreprocessorOutputFlag)
 332     {
 333         /* Duplicate the output to the user preprocessor (.i) file */
 334
 335         Actual = fwrite ((char *) Buffer, 1, Length,
 336             AslGbl_Files[ASL_FILE_PREPROCESSOR_USER].Handle);
 337         if (Actual != Length)
 338         {
 339             FlFileError (FileId, ASL_MSG_WRITE);
 340             AslAbort ();
 341         }
 342     }
 343 }
 344
 345
 346 /*******************************************************************************
 347  *
 348  * FUNCTION:    FlPrintFile
 349  *
 350  * PARAMETERS:  FileId              - Index into file info array
 351  *              Format              - Printf format string
 352  *              ...                 - Printf arguments
 353  *
 354  * RETURN:      None
 355  *
 356  * DESCRIPTION: Formatted write to an open file.
 357  *              NOTE: Aborts compiler on any error.
 358  *
 359  ******************************************************************************/
 360
 361 void
 362 FlPrintFile (
 363     UINT32                  FileId,
 364     char                    *Format,
 365     ...)
 366 {
 367     INT32                   Actual;
 368     va_list                 Args;
 369
 370
 371     va_start (Args, Format);
 372     Actual = vfprintf (AslGbl_Files[FileId].Handle, Format, Args);
 373     va_end (Args);
 374
 375     if (Actual == -1)
 376     {
 377         FlFileError (FileId, ASL_MSG_WRITE);
 378         AslAbort ();
 379     }
 380
 381     if ((FileId == ASL_FILE_PREPROCESSOR) &&
 382         AslGbl_PreprocessorOutputFlag)
 383     {
 384         /*
 385          * Duplicate the output to the user preprocessor (.i) file,
 386          * except: no #line directives.
 387          */
 388         if (!strncmp (Format, "#line", 5))
 389         {
 390             return;
 391         }
 392
 393         va_start (Args, Format);
 394         Actual = vfprintf (AslGbl_Files[ASL_FILE_PREPROCESSOR_USER].Handle,
 395             Format, Args);
 396         va_end (Args);
 397
 398         if (Actual == -1)
 399         {
 400             FlFileError (FileId, ASL_MSG_WRITE);
 401             AslAbort ();
 402         }
 403     }
 404 }
 405
 406
 407 /*******************************************************************************
 408  *
 409  * FUNCTION:    FlSeekFile
 410  *
 411  * PARAMETERS:  FileId              - Index into file info array
 412  *              Offset              - Absolute byte offset in file
 413  *
 414  * RETURN:      None
 415  *
 416  * DESCRIPTION: Seek to absolute offset.
 417  *              NOTE: Aborts compiler on any error.
 418  *
 419  ******************************************************************************/
 420
 421 void
 422 FlSeekFile (
 423     UINT32                  FileId,
 424     long                    Offset)
 425 {
 426     int                     Error;
 427
 428
 429     Error = fseek (AslGbl_Files[FileId].Handle, Offset, SEEK_SET);
 430     if (Error)
 431     {
 432         FlFileError (FileId, ASL_MSG_SEEK);
 433         AslAbort ();
 434     }
 435 }
 436
 437
 438 /*******************************************************************************
 439  *
 440  * FUNCTION:    FlCloseFile
 441  *
 442  * PARAMETERS:  FileId              - Index into file info array
 443  *
 444  * RETURN:      None
 445  *
 446  * DESCRIPTION: Close an open file. Aborts compiler on error
 447  *
 448  ******************************************************************************/
 449
 450 void
 451 FlCloseFile (
 452     UINT32                  FileId)
 453 {
 454     int                     Error;
 455
 456
 457     if (!AslGbl_Files[FileId].Handle)
 458     {
 459         return;
 460     }
 461
 462     Error = fclose (AslGbl_Files[FileId].Handle);
 463     if (Error)
 464     {
 465         FlFileError (FileId, ASL_MSG_CLOSE);
 466         AslAbort ();
 467     }
 468
 469     /* Do not clear/free the filename string */
 470
 471     AslGbl_Files[FileId].Handle = NULL;
 472     return;
 473 }
 474
 475
 476 /*******************************************************************************
 477  *
 478  * FUNCTION:    FlDeleteFile
 479  *
 480  * PARAMETERS:  FileId              - Index into file info array
 481  *
 482  * RETURN:      None
 483  *
 484  * DESCRIPTION: Delete a file.
 485  *
 486  ******************************************************************************/
 487
 488 void
 489 FlDeleteFile (
 490     UINT32                  FileId)
 491 {
 492     ASL_FILE_INFO           *Info = &AslGbl_Files[FileId];
 493
 494
 495     if (!Info->Filename)
 496     {
 497         return;
 498     }
 499
 500     if (remove (Info->Filename))
 501     {
 502         printf ("%s (%s file) ",
 503             Info->Filename, Info->Description);
 504         perror ("Could not delete");
 505     }
 506
 507     Info->Filename = NULL;
 508     return;
 509 }