Lv Zheng | 506f57d | 2014-04-04 12:39:42 +0800 | [diff] [blame] | 1 | /****************************************************************************** |
| 2 | * |
| 3 | * Module Name: apfiles - File-related functions for acpidump utility |
| 4 | * |
| 5 | *****************************************************************************/ |
| 6 | |
| 7 | /* |
Bob Moore | c8100dc | 2016-01-15 08:17:03 +0800 | [diff] [blame] | 8 | * Copyright (C) 2000 - 2016, Intel Corp. |
Lv Zheng | 506f57d | 2014-04-04 12:39:42 +0800 | [diff] [blame] | 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" |
Lv Zheng | 506f57d | 2014-04-04 12:39:42 +0800 | [diff] [blame] | 45 | |
Lv Zheng | 4d2c822 | 2014-07-08 10:07:59 +0800 | [diff] [blame] | 46 | /* Local prototypes */ |
| 47 | |
| 48 | static int ap_is_existing_file(char *pathname); |
| 49 | |
Bob Moore | 1fad873 | 2015-12-29 13:54:36 +0800 | [diff] [blame] | 50 | /****************************************************************************** |
| 51 | * |
| 52 | * FUNCTION: ap_is_existing_file |
| 53 | * |
| 54 | * PARAMETERS: pathname - Output filename |
| 55 | * |
| 56 | * RETURN: 0 on success |
| 57 | * |
| 58 | * DESCRIPTION: Query for file overwrite if it already exists. |
| 59 | * |
| 60 | ******************************************************************************/ |
| 61 | |
Lv Zheng | 4d2c822 | 2014-07-08 10:07:59 +0800 | [diff] [blame] | 62 | static int ap_is_existing_file(char *pathname) |
| 63 | { |
| 64 | #ifndef _GNU_EFI |
| 65 | struct stat stat_info; |
| 66 | |
| 67 | if (!stat(pathname, &stat_info)) { |
Lv Zheng | dd99cbc | 2016-08-04 16:45:13 +0800 | [diff] [blame] | 68 | fprintf(stderr, |
| 69 | "Target path already exists, overwrite? [y|n] "); |
Lv Zheng | 4d2c822 | 2014-07-08 10:07:59 +0800 | [diff] [blame] | 70 | |
| 71 | if (getchar() != 'y') { |
| 72 | return (-1); |
| 73 | } |
| 74 | } |
| 75 | #endif |
| 76 | |
| 77 | return 0; |
| 78 | } |
| 79 | |
Lv Zheng | 506f57d | 2014-04-04 12:39:42 +0800 | [diff] [blame] | 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 | { |
Lv Zheng | 846d6ef | 2014-07-08 10:07:52 +0800 | [diff] [blame] | 95 | ACPI_FILE file; |
Lv Zheng | 506f57d | 2014-04-04 12:39:42 +0800 | [diff] [blame] | 96 | |
| 97 | /* If file exists, prompt for overwrite */ |
| 98 | |
Lv Zheng | 4d2c822 | 2014-07-08 10:07:59 +0800 | [diff] [blame] | 99 | if (ap_is_existing_file(pathname) != 0) { |
| 100 | return (-1); |
Lv Zheng | 506f57d | 2014-04-04 12:39:42 +0800 | [diff] [blame] | 101 | } |
| 102 | |
| 103 | /* Point stdout to the file */ |
| 104 | |
Lv Zheng | dd99cbc | 2016-08-04 16:45:13 +0800 | [diff] [blame] | 105 | file = fopen(pathname, "w"); |
Lv Zheng | 506f57d | 2014-04-04 12:39:42 +0800 | [diff] [blame] | 106 | if (!file) { |
Lv Zheng | dd99cbc | 2016-08-04 16:45:13 +0800 | [diff] [blame] | 107 | fprintf(stderr, "Could not open output file: %s\n", pathname); |
Lv Zheng | 506f57d | 2014-04-04 12:39:42 +0800 | [diff] [blame] | 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]; |
Lv Zheng | dcaff16 | 2014-07-08 10:07:46 +0800 | [diff] [blame] | 136 | ACPI_FILE file; |
Lv Zheng | b597664 | 2016-08-04 16:44:31 +0800 | [diff] [blame] | 137 | acpi_size actual; |
Lv Zheng | 506f57d | 2014-04-04 12:39:42 +0800 | [diff] [blame] | 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 | } |
Bob Moore | 1fad873 | 2015-12-29 13:54:36 +0800 | [diff] [blame] | 151 | |
Bob Moore | 4fa4616 | 2015-07-01 14:45:11 +0800 | [diff] [blame] | 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]); |
Lv Zheng | 506f57d | 2014-04-04 12:39:42 +0800 | [diff] [blame] | 156 | filename[ACPI_NAME_SIZE] = 0; |
| 157 | |
| 158 | /* Handle multiple SSDts - create different filenames for each */ |
| 159 | |
| 160 | if (instance > 0) { |
Lv Zheng | f173a77 | 2016-08-04 16:45:06 +0800 | [diff] [blame] | 161 | snprintf(instance_str, sizeof(instance_str), "%u", instance); |
Bob Moore | 4fa4616 | 2015-07-01 14:45:11 +0800 | [diff] [blame] | 162 | strcat(filename, instance_str); |
Lv Zheng | 506f57d | 2014-04-04 12:39:42 +0800 | [diff] [blame] | 163 | } |
| 164 | |
Bob Moore | 842e7133 | 2015-10-19 10:25:04 +0800 | [diff] [blame] | 165 | strcat(filename, FILE_SUFFIX_BINARY_TABLE); |
Lv Zheng | 506f57d | 2014-04-04 12:39:42 +0800 | [diff] [blame] | 166 | |
| 167 | if (gbl_verbose_mode) { |
Lv Zheng | dd99cbc | 2016-08-04 16:45:13 +0800 | [diff] [blame] | 168 | fprintf(stderr, |
| 169 | "Writing [%4.4s] to binary file: %s 0x%X (%u) bytes\n", |
| 170 | table->signature, filename, table->length, |
| 171 | table->length); |
Lv Zheng | 506f57d | 2014-04-04 12:39:42 +0800 | [diff] [blame] | 172 | } |
| 173 | |
| 174 | /* Open the file and dump the entire table in binary mode */ |
| 175 | |
Lv Zheng | dd99cbc | 2016-08-04 16:45:13 +0800 | [diff] [blame] | 176 | file = fopen(filename, "wb"); |
Lv Zheng | 506f57d | 2014-04-04 12:39:42 +0800 | [diff] [blame] | 177 | if (!file) { |
Lv Zheng | dd99cbc | 2016-08-04 16:45:13 +0800 | [diff] [blame] | 178 | fprintf(stderr, "Could not open output file: %s\n", filename); |
Lv Zheng | 506f57d | 2014-04-04 12:39:42 +0800 | [diff] [blame] | 179 | return (-1); |
| 180 | } |
| 181 | |
Lv Zheng | dd99cbc | 2016-08-04 16:45:13 +0800 | [diff] [blame] | 182 | actual = fwrite(table, 1, table_length, file); |
Lv Zheng | 506f57d | 2014-04-04 12:39:42 +0800 | [diff] [blame] | 183 | if (actual != table_length) { |
Lv Zheng | dd99cbc | 2016-08-04 16:45:13 +0800 | [diff] [blame] | 184 | fprintf(stderr, "Error writing binary output file: %s\n", |
| 185 | filename); |
| 186 | fclose(file); |
Lv Zheng | 506f57d | 2014-04-04 12:39:42 +0800 | [diff] [blame] | 187 | return (-1); |
| 188 | } |
| 189 | |
Lv Zheng | dd99cbc | 2016-08-04 16:45:13 +0800 | [diff] [blame] | 190 | fclose(file); |
Lv Zheng | 506f57d | 2014-04-04 12:39:42 +0800 | [diff] [blame] | 191 | return (0); |
| 192 | } |
| 193 | |
| 194 | /****************************************************************************** |
| 195 | * |
| 196 | * FUNCTION: ap_get_table_from_file |
| 197 | * |
| 198 | * PARAMETERS: pathname - File containing the binary ACPI table |
| 199 | * out_file_size - Where the file size is returned |
| 200 | * |
| 201 | * RETURN: Buffer containing the ACPI table. NULL on error. |
| 202 | * |
| 203 | * DESCRIPTION: Open a file and read it entirely into a new buffer |
| 204 | * |
| 205 | ******************************************************************************/ |
| 206 | |
| 207 | struct acpi_table_header *ap_get_table_from_file(char *pathname, |
| 208 | u32 *out_file_size) |
| 209 | { |
| 210 | struct acpi_table_header *buffer = NULL; |
Lv Zheng | dcaff16 | 2014-07-08 10:07:46 +0800 | [diff] [blame] | 211 | ACPI_FILE file; |
Lv Zheng | 506f57d | 2014-04-04 12:39:42 +0800 | [diff] [blame] | 212 | u32 file_size; |
Lv Zheng | b597664 | 2016-08-04 16:44:31 +0800 | [diff] [blame] | 213 | acpi_size actual; |
Lv Zheng | 506f57d | 2014-04-04 12:39:42 +0800 | [diff] [blame] | 214 | |
| 215 | /* Must use binary mode */ |
| 216 | |
Lv Zheng | dd99cbc | 2016-08-04 16:45:13 +0800 | [diff] [blame] | 217 | file = fopen(pathname, "rb"); |
Lv Zheng | 506f57d | 2014-04-04 12:39:42 +0800 | [diff] [blame] | 218 | if (!file) { |
Lv Zheng | dd99cbc | 2016-08-04 16:45:13 +0800 | [diff] [blame] | 219 | fprintf(stderr, "Could not open input file: %s\n", pathname); |
Lv Zheng | 506f57d | 2014-04-04 12:39:42 +0800 | [diff] [blame] | 220 | return (NULL); |
| 221 | } |
| 222 | |
| 223 | /* Need file size to allocate a buffer */ |
| 224 | |
| 225 | file_size = cm_get_file_size(file); |
| 226 | if (file_size == ACPI_UINT32_MAX) { |
Lv Zheng | dd99cbc | 2016-08-04 16:45:13 +0800 | [diff] [blame] | 227 | fprintf(stderr, |
| 228 | "Could not get input file size: %s\n", pathname); |
Lv Zheng | 506f57d | 2014-04-04 12:39:42 +0800 | [diff] [blame] | 229 | goto cleanup; |
| 230 | } |
| 231 | |
| 232 | /* Allocate a buffer for the entire file */ |
| 233 | |
Lv Zheng | fbee6b2 | 2014-07-08 10:07:33 +0800 | [diff] [blame] | 234 | buffer = ACPI_ALLOCATE_ZEROED(file_size); |
Lv Zheng | 506f57d | 2014-04-04 12:39:42 +0800 | [diff] [blame] | 235 | if (!buffer) { |
Lv Zheng | dd99cbc | 2016-08-04 16:45:13 +0800 | [diff] [blame] | 236 | fprintf(stderr, |
| 237 | "Could not allocate file buffer of size: %u\n", |
| 238 | file_size); |
Lv Zheng | 506f57d | 2014-04-04 12:39:42 +0800 | [diff] [blame] | 239 | goto cleanup; |
| 240 | } |
| 241 | |
| 242 | /* Read the entire file */ |
| 243 | |
Lv Zheng | dd99cbc | 2016-08-04 16:45:13 +0800 | [diff] [blame] | 244 | actual = fread(buffer, 1, file_size, file); |
Lv Zheng | 506f57d | 2014-04-04 12:39:42 +0800 | [diff] [blame] | 245 | if (actual != file_size) { |
Lv Zheng | dd99cbc | 2016-08-04 16:45:13 +0800 | [diff] [blame] | 246 | fprintf(stderr, "Could not read input file: %s\n", pathname); |
Lv Zheng | fbee6b2 | 2014-07-08 10:07:33 +0800 | [diff] [blame] | 247 | ACPI_FREE(buffer); |
Lv Zheng | 506f57d | 2014-04-04 12:39:42 +0800 | [diff] [blame] | 248 | buffer = NULL; |
| 249 | goto cleanup; |
| 250 | } |
| 251 | |
| 252 | *out_file_size = file_size; |
| 253 | |
| 254 | cleanup: |
Lv Zheng | dd99cbc | 2016-08-04 16:45:13 +0800 | [diff] [blame] | 255 | fclose(file); |
Lv Zheng | 506f57d | 2014-04-04 12:39:42 +0800 | [diff] [blame] | 256 | return (buffer); |
| 257 | } |