tools/power/acpi/tools/acpidump/apfiles.c

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