drivers/acpi/tools/acpidump/apfiles.c

   1 /******************************************************************************
   2  *
   3  * Module Name: apfiles - File-related functions for acpidump utility
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2015, 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 #include "acpidump.h"
 117 #include "acapps.h"
 118
 119
 120 /* Local prototypes */
 121
 122 static int
 123 ApIsExistingFile (
 124     char                    *Pathname);
 125
 126
 127 static int
 128 ApIsExistingFile (
 129     char                    *Pathname)
 130 {
 131 #ifndef _GNU_EFI
 132     struct stat             StatInfo;
 133
 134
 135     if (!stat (Pathname, &StatInfo))
 136     {
 137         AcpiLogError ("Target path already exists, overwrite? [y|n] ");
 138
 139         if (getchar () != 'y')
 140         {
 141             return (-1);
 142         }
 143     }
 144 #endif
 145
 146     return 0;
 147 }
 148
 149
 150 /******************************************************************************
 151  *
 152  * FUNCTION:    ApOpenOutputFile
 153  *
 154  * PARAMETERS:  Pathname            - Output filename
 155  *
 156  * RETURN:      Open file handle
 157  *
 158  * DESCRIPTION: Open a text output file for acpidump. Checks if file already
 159  *              exists.
 160  *
 161  ******************************************************************************/
 162
 163 int
 164 ApOpenOutputFile (
 165     char                    *Pathname)
 166 {
 167     ACPI_FILE               File;
 168
 169
 170     /* If file exists, prompt for overwrite */
 171
 172     if (ApIsExistingFile (Pathname) != 0)
 173     {
 174         return (-1);
 175     }
 176
 177     /* Point stdout to the file */
 178
 179     File = AcpiOsOpenFile (Pathname, ACPI_FILE_WRITING);
 180     if (!File)
 181     {
 182         AcpiLogError ("Could not open output file: %s\n", Pathname);
 183         return (-1);
 184     }
 185
 186     /* Save the file and path */
 187
 188     Gbl_OutputFile = File;
 189     Gbl_OutputFilename = Pathname;
 190     return (0);
 191 }
 192
 193
 194 /******************************************************************************
 195  *
 196  * FUNCTION:    ApWriteToBinaryFile
 197  *
 198  * PARAMETERS:  Table               - ACPI table to be written
 199  *              Instance            - ACPI table instance no. to be written
 200  *
 201  * RETURN:      Status
 202  *
 203  * DESCRIPTION: Write an ACPI table to a binary file. Builds the output
 204  *              filename from the table signature.
 205  *
 206  ******************************************************************************/
 207
 208 int
 209 ApWriteToBinaryFile (
 210     ACPI_TABLE_HEADER       *Table,
 211     UINT32                  Instance)
 212 {
 213     char                    Filename[ACPI_NAME_SIZE + 16];
 214     char                    InstanceStr [16];
 215     ACPI_FILE               File;
 216     size_t                  Actual;
 217     UINT32                  TableLength;
 218
 219
 220     /* Obtain table length */
 221
 222     TableLength = ApGetTableLength (Table);
 223
 224     /* Construct lower-case filename from the table local signature */
 225
 226     if (ACPI_VALIDATE_RSDP_SIG (Table->Signature))
 227     {
 228         ACPI_MOVE_NAME (Filename, ACPI_RSDP_NAME);
 229     }
 230     else
 231     {
 232         ACPI_MOVE_NAME (Filename, Table->Signature);
 233     }
 234     Filename[0] = (char) ACPI_TOLOWER (Filename[0]);
 235     Filename[1] = (char) ACPI_TOLOWER (Filename[1]);
 236     Filename[2] = (char) ACPI_TOLOWER (Filename[2]);
 237     Filename[3] = (char) ACPI_TOLOWER (Filename[3]);
 238     Filename[ACPI_NAME_SIZE] = 0;
 239
 240     /* Handle multiple SSDTs - create different filenames for each */
 241
 242     if (Instance > 0)
 243     {
 244         AcpiUtSnprintf (InstanceStr, sizeof (InstanceStr), "%u", Instance);
 245         ACPI_STRCAT (Filename, InstanceStr);
 246     }
 247
 248     ACPI_STRCAT (Filename, ACPI_TABLE_FILE_SUFFIX);
 249
 250     if (Gbl_VerboseMode)
 251     {
 252         AcpiLogError (
 253             "Writing [%4.4s] to binary file: %s 0x%X (%u) bytes\n",
 254             Table->Signature, Filename, Table->Length, Table->Length);
 255     }
 256
 257     /* Open the file and dump the entire table in binary mode */
 258
 259     File = AcpiOsOpenFile (Filename,
 260         ACPI_FILE_WRITING | ACPI_FILE_BINARY);
 261     if (!File)
 262     {
 263         AcpiLogError ("Could not open output file: %s\n", Filename);
 264         return (-1);
 265     }
 266
 267     Actual = AcpiOsWriteFile (File, Table, 1, TableLength);
 268     if (Actual != TableLength)
 269     {
 270         AcpiLogError ("Error writing binary output file: %s\n", Filename);
 271         AcpiOsCloseFile (File);
 272         return (-1);
 273     }
 274
 275     AcpiOsCloseFile (File);
 276     return (0);
 277 }
 278
 279
 280 /******************************************************************************
 281  *
 282  * FUNCTION:    ApGetTableFromFile
 283  *
 284  * PARAMETERS:  Pathname            - File containing the binary ACPI table
 285  *              OutFileSize         - Where the file size is returned
 286  *
 287  * RETURN:      Buffer containing the ACPI table. NULL on error.
 288  *
 289  * DESCRIPTION: Open a file and read it entirely into a new buffer
 290  *
 291  ******************************************************************************/
 292
 293 ACPI_TABLE_HEADER *
 294 ApGetTableFromFile (
 295     char                    *Pathname,
 296     UINT32                  *OutFileSize)
 297 {
 298     ACPI_TABLE_HEADER       *Buffer = NULL;
 299     ACPI_FILE               File;
 300     UINT32                  FileSize;
 301     size_t                  Actual;
 302
 303
 304     /* Must use binary mode */
 305
 306     File = AcpiOsOpenFile (Pathname, ACPI_FILE_READING | ACPI_FILE_BINARY);
 307     if (!File)
 308     {
 309         AcpiLogError ("Could not open input file: %s\n", Pathname);
 310         return (NULL);
 311     }
 312
 313     /* Need file size to allocate a buffer */
 314
 315     FileSize = CmGetFileSize (File);
 316     if (FileSize == ACPI_UINT32_MAX)
 317     {
 318         AcpiLogError (
 319             "Could not get input file size: %s\n", Pathname);
 320         goto Cleanup;
 321     }
 322
 323     /* Allocate a buffer for the entire file */
 324
 325     Buffer = ACPI_ALLOCATE_ZEROED (FileSize);
 326     if (!Buffer)
 327     {
 328         AcpiLogError (
 329             "Could not allocate file buffer of size: %u\n", FileSize);
 330         goto Cleanup;
 331     }
 332
 333     /* Read the entire file */
 334
 335     Actual = AcpiOsReadFile (File, Buffer, 1, FileSize);
 336     if (Actual != FileSize)
 337     {
 338         AcpiLogError (
 339             "Could not read input file: %s\n", Pathname);
 340         ACPI_FREE (Buffer);
 341         Buffer = NULL;
 342         goto Cleanup;
 343     }
 344
 345     *OutFileSize = FileSize;
 346
 347 Cleanup:
 348     AcpiOsCloseFile (File);
 349     return (Buffer);
 350 }