Home | History | Annotate | Line # | Download | only in acpidump
apfiles.c revision 1.2.10.3
      1  1.2.10.2       tls /******************************************************************************
      2  1.2.10.2       tls  *
      3  1.2.10.2       tls  * Module Name: apfiles - File-related functions for acpidump utility
      4  1.2.10.2       tls  *
      5  1.2.10.2       tls  *****************************************************************************/
      6  1.2.10.2       tls 
      7  1.2.10.2       tls /*
      8  1.2.10.3  jdolecek  * Copyright (C) 2000 - 2017, Intel Corp.
      9  1.2.10.2       tls  * All rights reserved.
     10  1.2.10.2       tls  *
     11  1.2.10.2       tls  * Redistribution and use in source and binary forms, with or without
     12  1.2.10.2       tls  * modification, are permitted provided that the following conditions
     13  1.2.10.2       tls  * are met:
     14  1.2.10.2       tls  * 1. Redistributions of source code must retain the above copyright
     15  1.2.10.2       tls  *    notice, this list of conditions, and the following disclaimer,
     16  1.2.10.2       tls  *    without modification.
     17  1.2.10.2       tls  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
     18  1.2.10.2       tls  *    substantially similar to the "NO WARRANTY" disclaimer below
     19  1.2.10.2       tls  *    ("Disclaimer") and any redistribution must be conditioned upon
     20  1.2.10.2       tls  *    including a substantially similar Disclaimer requirement for further
     21  1.2.10.2       tls  *    binary redistribution.
     22  1.2.10.2       tls  * 3. Neither the names of the above-listed copyright holders nor the names
     23  1.2.10.2       tls  *    of any contributors may be used to endorse or promote products derived
     24  1.2.10.2       tls  *    from this software without specific prior written permission.
     25  1.2.10.2       tls  *
     26  1.2.10.2       tls  * Alternatively, this software may be distributed under the terms of the
     27  1.2.10.2       tls  * GNU General Public License ("GPL") version 2 as published by the Free
     28  1.2.10.2       tls  * Software Foundation.
     29  1.2.10.2       tls  *
     30  1.2.10.2       tls  * NO WARRANTY
     31  1.2.10.2       tls  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     32  1.2.10.2       tls  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     33  1.2.10.2       tls  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
     34  1.2.10.2       tls  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     35  1.2.10.2       tls  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     36  1.2.10.2       tls  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     37  1.2.10.2       tls  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     38  1.2.10.2       tls  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
     39  1.2.10.2       tls  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
     40  1.2.10.2       tls  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     41  1.2.10.2       tls  * POSSIBILITY OF SUCH DAMAGES.
     42  1.2.10.2       tls  */
     43  1.2.10.2       tls 
     44  1.2.10.2       tls #include "acpidump.h"
     45  1.2.10.3  jdolecek 
     46  1.2.10.3  jdolecek 
     47  1.2.10.3  jdolecek /* Local prototypes */
     48  1.2.10.3  jdolecek 
     49  1.2.10.3  jdolecek static int
     50  1.2.10.3  jdolecek ApIsExistingFile (
     51  1.2.10.3  jdolecek     char                    *Pathname);
     52  1.2.10.2       tls 
     53  1.2.10.2       tls 
     54  1.2.10.2       tls /******************************************************************************
     55  1.2.10.2       tls  *
     56  1.2.10.3  jdolecek  * FUNCTION:    ApIsExistingFile
     57  1.2.10.2       tls  *
     58  1.2.10.2       tls  * PARAMETERS:  Pathname            - Output filename
     59  1.2.10.2       tls  *
     60  1.2.10.3  jdolecek  * RETURN:      0 on success
     61  1.2.10.2       tls  *
     62  1.2.10.3  jdolecek  * DESCRIPTION: Query for file overwrite if it already exists.
     63  1.2.10.2       tls  *
     64  1.2.10.2       tls  ******************************************************************************/
     65  1.2.10.2       tls 
     66  1.2.10.3  jdolecek static int
     67  1.2.10.3  jdolecek ApIsExistingFile (
     68  1.2.10.2       tls     char                    *Pathname)
     69  1.2.10.2       tls {
     70  1.2.10.3  jdolecek #if !defined(_GNU_EFI) && !defined(_EDK2_EFI)
     71  1.2.10.2       tls     struct stat             StatInfo;
     72  1.2.10.2       tls 
     73  1.2.10.2       tls 
     74  1.2.10.2       tls     if (!stat (Pathname, &StatInfo))
     75  1.2.10.2       tls     {
     76  1.2.10.2       tls         fprintf (stderr, "Target path already exists, overwrite? [y|n] ");
     77  1.2.10.2       tls 
     78  1.2.10.2       tls         if (getchar () != 'y')
     79  1.2.10.2       tls         {
     80  1.2.10.2       tls             return (-1);
     81  1.2.10.2       tls         }
     82  1.2.10.2       tls     }
     83  1.2.10.3  jdolecek #endif
     84  1.2.10.3  jdolecek 
     85  1.2.10.3  jdolecek     return 0;
     86  1.2.10.3  jdolecek }
     87  1.2.10.3  jdolecek 
     88  1.2.10.3  jdolecek 
     89  1.2.10.3  jdolecek /******************************************************************************
     90  1.2.10.3  jdolecek  *
     91  1.2.10.3  jdolecek  * FUNCTION:    ApOpenOutputFile
     92  1.2.10.3  jdolecek  *
     93  1.2.10.3  jdolecek  * PARAMETERS:  Pathname            - Output filename
     94  1.2.10.3  jdolecek  *
     95  1.2.10.3  jdolecek  * RETURN:      Open file handle
     96  1.2.10.3  jdolecek  *
     97  1.2.10.3  jdolecek  * DESCRIPTION: Open a text output file for acpidump. Checks if file already
     98  1.2.10.3  jdolecek  *              exists.
     99  1.2.10.3  jdolecek  *
    100  1.2.10.3  jdolecek  ******************************************************************************/
    101  1.2.10.3  jdolecek 
    102  1.2.10.3  jdolecek int
    103  1.2.10.3  jdolecek ApOpenOutputFile (
    104  1.2.10.3  jdolecek     char                    *Pathname)
    105  1.2.10.3  jdolecek {
    106  1.2.10.3  jdolecek     ACPI_FILE               File;
    107  1.2.10.3  jdolecek 
    108  1.2.10.3  jdolecek 
    109  1.2.10.3  jdolecek     /* If file exists, prompt for overwrite */
    110  1.2.10.3  jdolecek 
    111  1.2.10.3  jdolecek     if (ApIsExistingFile (Pathname) != 0)
    112  1.2.10.3  jdolecek     {
    113  1.2.10.3  jdolecek         return (-1);
    114  1.2.10.3  jdolecek     }
    115  1.2.10.2       tls 
    116  1.2.10.2       tls     /* Point stdout to the file */
    117  1.2.10.2       tls 
    118  1.2.10.3  jdolecek     File = fopen (Pathname, "w");
    119  1.2.10.2       tls     if (!File)
    120  1.2.10.2       tls     {
    121  1.2.10.3  jdolecek         fprintf (stderr, "Could not open output file: %s\n", Pathname);
    122  1.2.10.2       tls         return (-1);
    123  1.2.10.2       tls     }
    124  1.2.10.2       tls 
    125  1.2.10.2       tls     /* Save the file and path */
    126  1.2.10.2       tls 
    127  1.2.10.2       tls     Gbl_OutputFile = File;
    128  1.2.10.2       tls     Gbl_OutputFilename = Pathname;
    129  1.2.10.2       tls     return (0);
    130  1.2.10.2       tls }
    131  1.2.10.2       tls 
    132  1.2.10.2       tls 
    133  1.2.10.2       tls /******************************************************************************
    134  1.2.10.2       tls  *
    135  1.2.10.2       tls  * FUNCTION:    ApWriteToBinaryFile
    136  1.2.10.2       tls  *
    137  1.2.10.2       tls  * PARAMETERS:  Table               - ACPI table to be written
    138  1.2.10.2       tls  *              Instance            - ACPI table instance no. to be written
    139  1.2.10.2       tls  *
    140  1.2.10.2       tls  * RETURN:      Status
    141  1.2.10.2       tls  *
    142  1.2.10.2       tls  * DESCRIPTION: Write an ACPI table to a binary file. Builds the output
    143  1.2.10.2       tls  *              filename from the table signature.
    144  1.2.10.2       tls  *
    145  1.2.10.2       tls  ******************************************************************************/
    146  1.2.10.2       tls 
    147  1.2.10.2       tls int
    148  1.2.10.2       tls ApWriteToBinaryFile (
    149  1.2.10.2       tls     ACPI_TABLE_HEADER       *Table,
    150  1.2.10.2       tls     UINT32                  Instance)
    151  1.2.10.2       tls {
    152  1.2.10.2       tls     char                    Filename[ACPI_NAME_SIZE + 16];
    153  1.2.10.2       tls     char                    InstanceStr [16];
    154  1.2.10.3  jdolecek     ACPI_FILE               File;
    155  1.2.10.3  jdolecek     ACPI_SIZE               Actual;
    156  1.2.10.2       tls     UINT32                  TableLength;
    157  1.2.10.2       tls 
    158  1.2.10.2       tls 
    159  1.2.10.2       tls     /* Obtain table length */
    160  1.2.10.2       tls 
    161  1.2.10.2       tls     TableLength = ApGetTableLength (Table);
    162  1.2.10.2       tls 
    163  1.2.10.2       tls     /* Construct lower-case filename from the table local signature */
    164  1.2.10.2       tls 
    165  1.2.10.2       tls     if (ACPI_VALIDATE_RSDP_SIG (Table->Signature))
    166  1.2.10.2       tls     {
    167  1.2.10.3  jdolecek         ACPI_MOVE_NAME (Filename, ACPI_RSDP_NAME);
    168  1.2.10.2       tls     }
    169  1.2.10.2       tls     else
    170  1.2.10.2       tls     {
    171  1.2.10.2       tls         ACPI_MOVE_NAME (Filename, Table->Signature);
    172  1.2.10.2       tls     }
    173  1.2.10.3  jdolecek 
    174  1.2.10.3  jdolecek     Filename[0] = (char) tolower ((int) Filename[0]);
    175  1.2.10.3  jdolecek     Filename[1] = (char) tolower ((int) Filename[1]);
    176  1.2.10.3  jdolecek     Filename[2] = (char) tolower ((int) Filename[2]);
    177  1.2.10.3  jdolecek     Filename[3] = (char) tolower ((int) Filename[3]);
    178  1.2.10.2       tls     Filename[ACPI_NAME_SIZE] = 0;
    179  1.2.10.2       tls 
    180  1.2.10.2       tls     /* Handle multiple SSDTs - create different filenames for each */
    181  1.2.10.2       tls 
    182  1.2.10.2       tls     if (Instance > 0)
    183  1.2.10.2       tls     {
    184  1.2.10.3  jdolecek         snprintf (InstanceStr, sizeof (InstanceStr), "%u", Instance);
    185  1.2.10.2       tls         strcat (Filename, InstanceStr);
    186  1.2.10.2       tls     }
    187  1.2.10.2       tls 
    188  1.2.10.3  jdolecek     strcat (Filename, FILE_SUFFIX_BINARY_TABLE);
    189  1.2.10.2       tls 
    190  1.2.10.2       tls     if (Gbl_VerboseMode)
    191  1.2.10.2       tls     {
    192  1.2.10.2       tls         fprintf (stderr,
    193  1.2.10.2       tls             "Writing [%4.4s] to binary file: %s 0x%X (%u) bytes\n",
    194  1.2.10.2       tls             Table->Signature, Filename, Table->Length, Table->Length);
    195  1.2.10.2       tls     }
    196  1.2.10.2       tls 
    197  1.2.10.2       tls     /* Open the file and dump the entire table in binary mode */
    198  1.2.10.2       tls 
    199  1.2.10.2       tls     File = fopen (Filename, "wb");
    200  1.2.10.2       tls     if (!File)
    201  1.2.10.2       tls     {
    202  1.2.10.3  jdolecek         fprintf (stderr, "Could not open output file: %s\n", Filename);
    203  1.2.10.2       tls         return (-1);
    204  1.2.10.2       tls     }
    205  1.2.10.2       tls 
    206  1.2.10.2       tls     Actual = fwrite (Table, 1, TableLength, File);
    207  1.2.10.2       tls     if (Actual != TableLength)
    208  1.2.10.2       tls     {
    209  1.2.10.3  jdolecek         fprintf (stderr, "Error writing binary output file: %s\n", Filename);
    210  1.2.10.2       tls         fclose (File);
    211  1.2.10.2       tls         return (-1);
    212  1.2.10.2       tls     }
    213  1.2.10.2       tls 
    214  1.2.10.2       tls     fclose (File);
    215  1.2.10.2       tls     return (0);
    216  1.2.10.2       tls }
    217  1.2.10.2       tls 
    218  1.2.10.2       tls 
    219  1.2.10.2       tls /******************************************************************************
    220  1.2.10.2       tls  *
    221  1.2.10.2       tls  * FUNCTION:    ApGetTableFromFile
    222  1.2.10.2       tls  *
    223  1.2.10.2       tls  * PARAMETERS:  Pathname            - File containing the binary ACPI table
    224  1.2.10.2       tls  *              OutFileSize         - Where the file size is returned
    225  1.2.10.2       tls  *
    226  1.2.10.2       tls  * RETURN:      Buffer containing the ACPI table. NULL on error.
    227  1.2.10.2       tls  *
    228  1.2.10.2       tls  * DESCRIPTION: Open a file and read it entirely into a new buffer
    229  1.2.10.2       tls  *
    230  1.2.10.2       tls  ******************************************************************************/
    231  1.2.10.2       tls 
    232  1.2.10.2       tls ACPI_TABLE_HEADER *
    233  1.2.10.2       tls ApGetTableFromFile (
    234  1.2.10.2       tls     char                    *Pathname,
    235  1.2.10.2       tls     UINT32                  *OutFileSize)
    236  1.2.10.2       tls {
    237  1.2.10.2       tls     ACPI_TABLE_HEADER       *Buffer = NULL;
    238  1.2.10.3  jdolecek     ACPI_FILE               File;
    239  1.2.10.2       tls     UINT32                  FileSize;
    240  1.2.10.3  jdolecek     ACPI_SIZE               Actual;
    241  1.2.10.2       tls 
    242  1.2.10.2       tls 
    243  1.2.10.2       tls     /* Must use binary mode */
    244  1.2.10.2       tls 
    245  1.2.10.2       tls     File = fopen (Pathname, "rb");
    246  1.2.10.2       tls     if (!File)
    247  1.2.10.2       tls     {
    248  1.2.10.3  jdolecek         fprintf (stderr, "Could not open input file: %s\n", Pathname);
    249  1.2.10.2       tls         return (NULL);
    250  1.2.10.2       tls     }
    251  1.2.10.2       tls 
    252  1.2.10.2       tls     /* Need file size to allocate a buffer */
    253  1.2.10.2       tls 
    254  1.2.10.3  jdolecek     FileSize = CmGetFileSize (File);
    255  1.2.10.3  jdolecek     if (FileSize == ACPI_UINT32_MAX)
    256  1.2.10.2       tls     {
    257  1.2.10.2       tls         fprintf (stderr,
    258  1.2.10.2       tls             "Could not get input file size: %s\n", Pathname);
    259  1.2.10.2       tls         goto Cleanup;
    260  1.2.10.2       tls     }
    261  1.2.10.2       tls 
    262  1.2.10.2       tls     /* Allocate a buffer for the entire file */
    263  1.2.10.2       tls 
    264  1.2.10.3  jdolecek     Buffer = ACPI_ALLOCATE_ZEROED (FileSize);
    265  1.2.10.2       tls     if (!Buffer)
    266  1.2.10.2       tls     {
    267  1.2.10.2       tls         fprintf (stderr,
    268  1.2.10.2       tls             "Could not allocate file buffer of size: %u\n", FileSize);
    269  1.2.10.2       tls         goto Cleanup;
    270  1.2.10.2       tls     }
    271  1.2.10.2       tls 
    272  1.2.10.2       tls     /* Read the entire file */
    273  1.2.10.2       tls 
    274  1.2.10.2       tls     Actual = fread (Buffer, 1, FileSize, File);
    275  1.2.10.2       tls     if (Actual != FileSize)
    276  1.2.10.2       tls     {
    277  1.2.10.3  jdolecek         fprintf (stderr, "Could not read input file: %s\n", Pathname);
    278  1.2.10.3  jdolecek         ACPI_FREE (Buffer);
    279  1.2.10.2       tls         Buffer = NULL;
    280  1.2.10.2       tls         goto Cleanup;
    281  1.2.10.2       tls     }
    282  1.2.10.2       tls 
    283  1.2.10.2       tls     *OutFileSize = FileSize;
    284  1.2.10.2       tls 
    285  1.2.10.2       tls Cleanup:
    286  1.2.10.2       tls     fclose (File);
    287  1.2.10.2       tls     return (Buffer);
    288  1.2.10.2       tls }
    289