xref: /freebsd/sys/contrib/dev/acpica/common/adfile.c (revision cfd6422a5217410fbd66f7a7a8a64d9d85e61229)
1 /******************************************************************************
2  *
3  * Module Name: adfile - Application-level disassembler file support routines
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2020, 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 <contrib/dev/acpica/compiler/aslcompiler.h>
153 #include <contrib/dev/acpica/include/acpi.h>
154 #include <contrib/dev/acpica/include/accommon.h>
155 #include <contrib/dev/acpica/include/acapps.h>
156 
157 #include <stdio.h>
158 
159 
160 #define _COMPONENT          ACPI_TOOLS
161         ACPI_MODULE_NAME    ("adfile")
162 
163 /* Local prototypes */
164 
165 static INT32
166 AdWriteBuffer (
167     char                    *Filename,
168     char                    *Buffer,
169     UINT32                  Length);
170 
171 static char                 FilenameBuf[20];
172 
173 
174 /******************************************************************************
175  *
176  * FUNCTION:    AfGenerateFilename
177  *
178  * PARAMETERS:  Prefix              - prefix string
179  *              TableId             - The table ID
180  *
181  * RETURN:      Pointer to the completed string
182  *
183  * DESCRIPTION: Build an output filename from an ACPI table ID string
184  *
185  ******************************************************************************/
186 
187 char *
188 AdGenerateFilename (
189     char                    *Prefix,
190     char                    *TableId)
191 {
192     UINT32                  i;
193     UINT32                  j;
194 
195 
196     for (i = 0; Prefix[i]; i++)
197     {
198         FilenameBuf[i] = Prefix[i];
199     }
200 
201     FilenameBuf[i] = '_';
202     i++;
203 
204     for (j = 0; j < 8 && (TableId[j] != ' ') && (TableId[j] != 0); i++, j++)
205     {
206         FilenameBuf[i] = TableId[j];
207     }
208 
209     FilenameBuf[i] = 0;
210     strcat (FilenameBuf, FILE_SUFFIX_BINARY_TABLE);
211     return (FilenameBuf);
212 }
213 
214 
215 /******************************************************************************
216  *
217  * FUNCTION:    AfWriteBuffer
218  *
219  * PARAMETERS:  Filename            - name of file
220  *              Buffer              - data to write
221  *              Length              - length of data
222  *
223  * RETURN:      Actual number of bytes written
224  *
225  * DESCRIPTION: Open a file and write out a single buffer
226  *
227  ******************************************************************************/
228 
229 static INT32
230 AdWriteBuffer (
231     char                    *Filename,
232     char                    *Buffer,
233     UINT32                  Length)
234 {
235     FILE                    *File;
236     ACPI_SIZE               Actual;
237 
238 
239     File = fopen (Filename, "wb");
240     if (!File)
241     {
242         printf ("Could not open file %s\n", Filename);
243         return (-1);
244     }
245 
246     Actual = fwrite (Buffer, 1, (size_t) Length, File);
247     if (Actual != Length)
248     {
249         printf ("Could not write to file %s\n", Filename);
250     }
251 
252     fclose (File);
253     return ((INT32) Actual);
254 }
255 
256 
257 /******************************************************************************
258  *
259  * FUNCTION:    AfWriteTable
260  *
261  * PARAMETERS:  Table               - pointer to the ACPI table
262  *              Length              - length of the table
263  *              TableName           - the table signature
264  *              OemTableID          - from the table header
265  *
266  * RETURN:      None
267  *
268  * DESCRIPTION: Dump the loaded tables to a file (or files)
269  *
270  ******************************************************************************/
271 
272 void
273 AdWriteTable (
274     ACPI_TABLE_HEADER       *Table,
275     UINT32                  Length,
276     char                    *TableName,
277     char                    *OemTableId)
278 {
279     char                    *Filename;
280 
281 
282     Filename = AdGenerateFilename (TableName, OemTableId);
283     AdWriteBuffer (Filename, (char *) Table, Length);
284 
285     AcpiOsPrintf ("Table [%s] written to \"%s\"\n", TableName, Filename);
286 }
287 
288 
289 /*******************************************************************************
290  *
291  * FUNCTION:    FlGenerateFilename
292  *
293  * PARAMETERS:  InputFilename       - Original ASL source filename
294  *              Suffix              - New extension.
295  *
296  * RETURN:      New filename containing the original base + the new suffix
297  *
298  * DESCRIPTION: Generate a new filename from the ASL source filename and a new
299  *              extension. Used to create the *.LST, *.TXT, etc. files.
300  *
301  ******************************************************************************/
302 
303 char *
304 FlGenerateFilename (
305     char                    *InputFilename,
306     char                    *Suffix)
307 {
308     char                    *Position;
309     char                    *NewFilename;
310     char                    *DirectoryPosition;
311 
312 
313     /*
314      * Copy the original filename to a new buffer. Leave room for the worst
315      * case where we append the suffix, an added dot and the null terminator.
316      */
317     NewFilename = UtLocalCacheCalloc ((ACPI_SIZE)
318         strlen (InputFilename) + strlen (Suffix) + 2);
319     strcpy (NewFilename, InputFilename);
320 
321     /* Try to find the last dot in the filename */
322 
323     DirectoryPosition = strrchr (NewFilename, '/');
324     Position = strrchr (NewFilename, '.');
325 
326     if (Position && (Position > DirectoryPosition))
327     {
328         /* Tack on the new suffix */
329 
330         Position++;
331         *Position = 0;
332         strcat (Position, Suffix);
333     }
334     else
335     {
336         /* No dot, add one and then the suffix */
337 
338         strcat (NewFilename, ".");
339         strcat (NewFilename, Suffix);
340     }
341 
342     return (NewFilename);
343 }
344 
345 
346 /*******************************************************************************
347  *
348  * FUNCTION:    FlStrdup
349  *
350  * DESCRIPTION: Local strdup function
351  *
352  ******************************************************************************/
353 
354 static char *
355 FlStrdup (
356     char                *String)
357 {
358     char                *NewString;
359 
360 
361     NewString = UtLocalCacheCalloc ((ACPI_SIZE) strlen (String) + 1);
362     strcpy (NewString, String);
363     return (NewString);
364 }
365 
366 
367 /*******************************************************************************
368  *
369  * FUNCTION:    FlSplitInputPathname
370  *
371  * PARAMETERS:  InputFilename       - The user-specified ASL source file to be
372  *                                    compiled
373  *              OutDirectoryPath    - Where the directory path prefix is
374  *                                    returned
375  *              OutFilename         - Where the filename part is returned
376  *
377  * RETURN:      Status
378  *
379  * DESCRIPTION: Split the input path into a directory and filename part
380  *              1) Directory part used to open include files
381  *              2) Filename part used to generate output filenames
382  *
383  ******************************************************************************/
384 
385 ACPI_STATUS
386 FlSplitInputPathname (
387     char                    *InputPath,
388     char                    **OutDirectoryPath,
389     char                    **OutFilename)
390 {
391     char                    *Substring;
392     char                    *DirectoryPath;
393     char                    *Filename;
394 
395 
396     if (OutDirectoryPath)
397     {
398         *OutDirectoryPath = NULL;
399     }
400 
401     if (!InputPath)
402     {
403         return (AE_OK);
404     }
405 
406     /* Get the path to the input filename's directory */
407 
408     DirectoryPath = FlStrdup (InputPath);
409     if (!DirectoryPath)
410     {
411         return (AE_NO_MEMORY);
412     }
413 
414     /* Convert backslashes to slashes in the entire path */
415 
416     UtConvertBackslashes (DirectoryPath);
417 
418     /* Backup to last slash or colon */
419 
420     Substring = strrchr (DirectoryPath, '/');
421     if (!Substring)
422     {
423         Substring = strrchr (DirectoryPath, ':');
424     }
425 
426     /* Extract the simple filename */
427 
428     if (!Substring)
429     {
430         Filename = FlStrdup (DirectoryPath);
431         DirectoryPath[0] = 0;
432     }
433     else
434     {
435         Filename = FlStrdup (Substring + 1);
436         *(Substring+1) = 0;
437     }
438 
439     if (!Filename)
440     {
441         return (AE_NO_MEMORY);
442     }
443 
444     if (OutDirectoryPath)
445     {
446         *OutDirectoryPath = DirectoryPath;
447     }
448 
449     if (OutFilename)
450     {
451         *OutFilename = Filename;
452         return (AE_OK);
453     }
454 
455     return (AE_OK);
456 }
457 
458 
459 /*******************************************************************************
460  *
461  * FUNCTION:    FlGetFileBasename
462  *
463  * PARAMETERS:  FilePathname            - File path to be split
464  *
465  * RETURN:      The extracted base name of the file, in upper case
466  *
467  * DESCRIPTION: Extract the file base name (the file name with no extension)
468  *              from the input pathname.
469  *
470  *              Note: Any backslashes in the pathname should be previously
471  *              converted to forward slashes before calling this function.
472  *
473  ******************************************************************************/
474 
475 char *
476 FlGetFileBasename (
477     char                    *FilePathname)
478 {
479     char                    *FileBasename;
480     char                    *Substring;
481 
482 
483     /* Backup to last slash or colon */
484 
485     Substring = strrchr (FilePathname, '/');
486     if (!Substring)
487     {
488         Substring = strrchr (FilePathname, ':');
489     }
490 
491     /* Extract the full filename (base + extension) */
492 
493     if (Substring)
494     {
495         FileBasename = FlStrdup (Substring + 1);
496     }
497     else
498     {
499         FileBasename = FlStrdup (FilePathname);
500     }
501 
502     /* Remove the filename extension if present */
503 
504     Substring = strchr (FileBasename, '.');
505     if (Substring)
506     {
507         *Substring = 0;
508     }
509 
510     AcpiUtStrupr (FileBasename);
511     return (FileBasename);
512 }
513