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 - 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 "acpidump.h"
153
154
155 /* Local prototypes */
156
157 static int
158 ApIsExistingFile (
159 char *Pathname);
160
161
162 /******************************************************************************
163 *
164 * FUNCTION: ApIsExistingFile
165 *
166 * PARAMETERS: Pathname - Output filename
167 *
168 * RETURN: 0 on success
169 *
170 * DESCRIPTION: Query for file overwrite if it already exists.
171 *
172 ******************************************************************************/
173
174 static int
ApIsExistingFile(char * Pathname)175 ApIsExistingFile (
176 char *Pathname)
177 {
178 #if !defined(_GNU_EFI) && !defined(_EDK2_EFI)
179 struct stat StatInfo;
180
181
182 if (!stat (Pathname, &StatInfo))
183 {
184 fprintf (stderr, "Target path already exists, overwrite? [y|n] ");
185
186 if (getchar () != 'y')
187 {
188 return (-1);
189 }
190 }
191 #endif
192
193 return 0;
194 }
195
196
197 /******************************************************************************
198 *
199 * FUNCTION: ApOpenOutputFile
200 *
201 * PARAMETERS: Pathname - Output filename
202 *
203 * RETURN: Open file handle
204 *
205 * DESCRIPTION: Open a text output file for acpidump. Checks if file already
206 * exists.
207 *
208 ******************************************************************************/
209
210 int
ApOpenOutputFile(char * Pathname)211 ApOpenOutputFile (
212 char *Pathname)
213 {
214 ACPI_FILE File;
215
216
217 /* If file exists, prompt for overwrite */
218
219 if (ApIsExistingFile (Pathname) != 0)
220 {
221 return (-1);
222 }
223
224 /* Point stdout to the file */
225
226 File = fopen (Pathname, "w");
227 if (!File)
228 {
229 fprintf (stderr, "Could not open output file: %s\n", Pathname);
230 return (-1);
231 }
232
233 /* Save the file and path */
234
235 Gbl_OutputFile = File;
236 Gbl_OutputFilename = Pathname;
237 return (0);
238 }
239
240
241 /******************************************************************************
242 *
243 * FUNCTION: ApWriteToBinaryFile
244 *
245 * PARAMETERS: Table - ACPI table to be written
246 * Instance - ACPI table instance no. to be written
247 *
248 * RETURN: Status
249 *
250 * DESCRIPTION: Write an ACPI table to a binary file. Builds the output
251 * filename from the table signature.
252 *
253 ******************************************************************************/
254
255 int
ApWriteToBinaryFile(ACPI_TABLE_HEADER * Table,UINT32 Instance)256 ApWriteToBinaryFile (
257 ACPI_TABLE_HEADER *Table,
258 UINT32 Instance)
259 {
260 char Filename[ACPI_NAME_SIZE + 16];
261 char InstanceStr [16];
262 ACPI_FILE File;
263 ACPI_SIZE Actual;
264 UINT32 TableLength;
265
266
267 /* Obtain table length */
268
269 TableLength = ApGetTableLength (Table);
270
271 /* Construct lower-case filename from the table local signature */
272
273 if (ACPI_VALIDATE_RSDP_SIG (Table->Signature))
274 {
275 ACPI_MOVE_NAME (Filename, ACPI_RSDP_NAME);
276 }
277 else
278 {
279 ACPI_MOVE_NAME (Filename, Table->Signature);
280 }
281
282 Filename[0] = (char) tolower ((int) Filename[0]);
283 Filename[1] = (char) tolower ((int) Filename[1]);
284 Filename[2] = (char) tolower ((int) Filename[2]);
285 Filename[3] = (char) tolower ((int) Filename[3]);
286 Filename[ACPI_NAME_SIZE] = 0;
287
288 /* Handle multiple SSDTs - create different filenames for each */
289
290 if (Instance > 0)
291 {
292 snprintf (InstanceStr, sizeof (InstanceStr), "%u", Instance);
293 strcat (Filename, InstanceStr);
294 }
295
296 strcat (Filename, FILE_SUFFIX_BINARY_TABLE);
297
298 if (Gbl_VerboseMode)
299 {
300 fprintf (stderr,
301 "Writing [%4.4s] to binary file: %s 0x%X (%u) bytes\n",
302 Table->Signature, Filename, Table->Length, Table->Length);
303 }
304
305 /* Open the file and dump the entire table in binary mode */
306
307 File = fopen (Filename, "wb");
308 if (!File)
309 {
310 fprintf (stderr, "Could not open output file: %s\n", Filename);
311 return (-1);
312 }
313
314 Actual = fwrite (Table, 1, TableLength, File);
315 if (Actual != TableLength)
316 {
317 fprintf (stderr, "Error writing binary output file: %s\n", Filename);
318 fclose (File);
319 return (-1);
320 }
321
322 fclose (File);
323 return (0);
324 }
325
326
327 /******************************************************************************
328 *
329 * FUNCTION: ApGetTableFromFile
330 *
331 * PARAMETERS: Pathname - File containing the binary ACPI table
332 * OutFileSize - Where the file size is returned
333 *
334 * RETURN: Buffer containing the ACPI table. NULL on error.
335 *
336 * DESCRIPTION: Open a file and read it entirely into a new buffer
337 *
338 ******************************************************************************/
339
340 ACPI_TABLE_HEADER *
ApGetTableFromFile(char * Pathname,UINT32 * OutFileSize)341 ApGetTableFromFile (
342 char *Pathname,
343 UINT32 *OutFileSize)
344 {
345 ACPI_TABLE_HEADER *Buffer = NULL;
346 ACPI_FILE File;
347 UINT32 FileSize;
348 ACPI_SIZE Actual;
349
350
351 /* Must use binary mode */
352
353 File = fopen (Pathname, "rb");
354 if (!File)
355 {
356 fprintf (stderr, "Could not open input file: %s\n", Pathname);
357 return (NULL);
358 }
359
360 /* Need file size to allocate a buffer */
361
362 FileSize = CmGetFileSize (File);
363 if (FileSize == ACPI_UINT32_MAX)
364 {
365 fprintf (stderr,
366 "Could not get input file size: %s\n", Pathname);
367 goto Cleanup;
368 }
369
370 /* Allocate a buffer for the entire file */
371
372 Buffer = ACPI_ALLOCATE_ZEROED (FileSize);
373 if (!Buffer)
374 {
375 fprintf (stderr,
376 "Could not allocate file buffer of size: %u\n", FileSize);
377 goto Cleanup;
378 }
379
380 /* Read the entire file */
381
382 Actual = fread (Buffer, 1, FileSize, File);
383 if (Actual != FileSize)
384 {
385 fprintf (stderr, "Could not read input file: %s\n", Pathname);
386 ACPI_FREE (Buffer);
387 Buffer = NULL;
388 goto Cleanup;
389 }
390
391 *OutFileSize = FileSize;
392
393 Cleanup:
394 fclose (File);
395 return (Buffer);
396 }
397