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