xref: /freebsd/sys/contrib/dev/acpica/common/adfile.c (revision 78007886c995898a9494648343e5236bca1cbba3)
1 /******************************************************************************
2  *
3  * Module Name: adfile - Application-level disassembler file support routines
4  *              $Revision: 1.3 $
5  *
6  *****************************************************************************/
7 
8 /******************************************************************************
9  *
10  * 1. Copyright Notice
11  *
12  * Some or all of this work - Copyright (c) 1999 - 2007, Intel Corp.
13  * All rights reserved.
14  *
15  * 2. License
16  *
17  * 2.1. This is your license from Intel Corp. under its intellectual property
18  * rights.  You may have additional license terms from the party that provided
19  * you this software, covering your right to use that party's intellectual
20  * property rights.
21  *
22  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23  * copy of the source code appearing in this file ("Covered Code") an
24  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25  * base code distributed originally by Intel ("Original Intel Code") to copy,
26  * make derivatives, distribute, use and display any portion of the Covered
27  * Code in any form, with the right to sublicense such rights; and
28  *
29  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30  * license (with the right to sublicense), under only those claims of Intel
31  * patents that are infringed by the Original Intel Code, to make, use, sell,
32  * offer to sell, and import the Covered Code and derivative works thereof
33  * solely to the minimum extent necessary to exercise the above copyright
34  * license, and in no event shall the patent license extend to any additions
35  * to or modifications of the Original Intel Code.  No other license or right
36  * is granted directly or by implication, estoppel or otherwise;
37  *
38  * The above copyright and patent license is granted only if the following
39  * conditions are met:
40  *
41  * 3. Conditions
42  *
43  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44  * Redistribution of source code of any substantial portion of the Covered
45  * Code or modification with rights to further distribute source must include
46  * the above Copyright Notice, the above License, this list of Conditions,
47  * and the following Disclaimer and Export Compliance provision.  In addition,
48  * Licensee must cause all Covered Code to which Licensee contributes to
49  * contain a file documenting the changes Licensee made to create that Covered
50  * Code and the date of any change.  Licensee must include in that file the
51  * documentation of any changes made by any predecessor Licensee.  Licensee
52  * must include a prominent statement that the modification is derived,
53  * directly or indirectly, from Original Intel Code.
54  *
55  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56  * Redistribution of source code of any substantial portion of the Covered
57  * Code or modification without rights to further distribute source must
58  * include the following Disclaimer and Export Compliance provision in the
59  * documentation and/or other materials provided with distribution.  In
60  * addition, Licensee may not authorize further sublicense of source of any
61  * portion of the Covered Code, and must include terms to the effect that the
62  * license from Licensee to its licensee is limited to the intellectual
63  * property embodied in the software Licensee provides to its licensee, and
64  * not to intellectual property embodied in modifications its licensee may
65  * make.
66  *
67  * 3.3. Redistribution of Executable. Redistribution in executable form of any
68  * substantial portion of the Covered Code or modification must reproduce the
69  * above Copyright Notice, and the following Disclaimer and Export Compliance
70  * provision in the documentation and/or other materials provided with the
71  * distribution.
72  *
73  * 3.4. Intel retains all right, title, and interest in and to the Original
74  * Intel Code.
75  *
76  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77  * Intel shall be used in advertising or otherwise to promote the sale, use or
78  * other dealings in products derived from or relating to the Covered Code
79  * without prior written authorization from Intel.
80  *
81  * 4. Disclaimer and Export Compliance
82  *
83  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
86  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
87  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
88  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
89  * PARTICULAR PURPOSE.
90  *
91  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
97  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
98  * LIMITED REMEDY.
99  *
100  * 4.3. Licensee shall not export, either directly or indirectly, any of this
101  * software or system incorporating such software without first obtaining any
102  * required license or other approval from the U. S. Department of Commerce or
103  * any other agency or department of the United States Government.  In the
104  * event Licensee exports any such software from the United States or
105  * re-exports any such software from a foreign destination, Licensee shall
106  * ensure that the distribution and export/re-export of the software is in
107  * compliance with all laws, regulations, orders, or other restrictions of the
108  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109  * any of its subsidiaries will export/re-export any technical data, process,
110  * software, or service, directly or indirectly, to any country for which the
111  * United States government or any agency thereof requires an export license,
112  * other governmental approval, or letter of assurance, without first obtaining
113  * such license, approval or letter.
114  *
115  *****************************************************************************/
116 
117 
118 #include <contrib/dev/acpica/acpi.h>
119 #include <contrib/dev/acpica/acapps.h>
120 
121 #include <stdio.h>
122 #include <string.h>
123 
124 
125 #define _COMPONENT          ACPI_TOOLS
126         ACPI_MODULE_NAME    ("adfile")
127 
128 
129 char                        FilenameBuf[20];
130 
131 /******************************************************************************
132  *
133  * FUNCTION:    AfGenerateFilename
134  *
135  * PARAMETERS:  Prefix      - prefix string
136  *              TableId     - The table ID
137  *
138  * RETURN:      Pointer to the completed string
139  *
140  * DESCRIPTION: Build an output filename from an ACPI table ID string
141  *
142  ******************************************************************************/
143 
144 char *
145 AdGenerateFilename (
146     char                    *Prefix,
147     char                    *TableId)
148 {
149     ACPI_NATIVE_UINT         i;
150     ACPI_NATIVE_UINT         j;
151 
152 
153     for (i = 0; Prefix[i]; i++)
154     {
155         FilenameBuf[i] = Prefix[i];
156     }
157 
158     FilenameBuf[i] = '_';
159     i++;
160 
161     for (j = 0; j < 8 && (TableId[j] != ' ') && (TableId[j] != 0); i++, j++)
162     {
163         FilenameBuf[i] = TableId[j];
164     }
165 
166     FilenameBuf[i] = 0;
167     strcat (FilenameBuf, ACPI_TABLE_FILE_SUFFIX);
168     return FilenameBuf;
169 }
170 
171 
172 /******************************************************************************
173  *
174  * FUNCTION:    AfWriteBuffer
175  *
176  * PARAMETERS:  Filename        - name of file
177  *              Buffer          - data to write
178  *              Length          - length of data
179  *
180  * RETURN:      Actual number of bytes written
181  *
182  * DESCRIPTION: Open a file and write out a single buffer
183  *
184  ******************************************************************************/
185 
186 ACPI_NATIVE_INT
187 AdWriteBuffer (
188     char                *Filename,
189     char                *Buffer,
190     UINT32              Length)
191 {
192     FILE                *fp;
193     ACPI_SIZE           Actual;
194 
195 
196     fp = fopen (Filename, "wb");
197     if (!fp)
198     {
199         printf ("Couldn't open %s\n", Filename);
200         return (-1);
201     }
202 
203     Actual = fwrite (Buffer, (size_t) Length, 1, fp);
204     fclose (fp);
205     return ((ACPI_NATIVE_INT) Actual);
206 }
207 
208 
209 /******************************************************************************
210  *
211  * FUNCTION:    AfWriteTable
212  *
213  * PARAMETERS:  Table       - pointer to the ACPI table
214  *              Length      - length of the table
215  *              TableName   - the table signature
216  *              OemTableID  - from the table header
217  *
218  * RETURN:      None
219  *
220  * DESCRIPTION: Dump the loaded tables to a file (or files)
221  *
222  ******************************************************************************/
223 
224 void
225 AdWriteTable (
226     ACPI_TABLE_HEADER       *Table,
227     UINT32                  Length,
228     char                    *TableName,
229     char                    *OemTableId)
230 {
231     char                    *Filename;
232 
233 
234     Filename = AdGenerateFilename (TableName, OemTableId);
235     AdWriteBuffer (Filename, (char *) Table, Length);
236 
237     AcpiOsPrintf ("Table [%s] written to \"%s\"\n", TableName, Filename);
238 }
239 
240 
241 /*******************************************************************************
242  *
243  * FUNCTION:    FlGenerateFilename
244  *
245  * PARAMETERS:  InputFilename       - Original ASL source filename
246  *              Suffix              - New extension.
247  *
248  * RETURN:      New filename containing the original base + the new suffix
249  *
250  * DESCRIPTION: Generate a new filename from the ASL source filename and a new
251  *              extension.  Used to create the *.LST, *.TXT, etc. files.
252  *
253  ******************************************************************************/
254 
255 char *
256 FlGenerateFilename (
257     char                    *InputFilename,
258     char                    *Suffix)
259 {
260     char                    *Position;
261     char                    *NewFilename;
262 
263 
264     /*
265      * Copy the original filename to a new buffer. Leave room for the worst case
266      * where we append the suffix, an added dot and the null terminator.
267      */
268     NewFilename = ACPI_ALLOCATE_ZEROED (
269         strlen (InputFilename) + strlen (Suffix) + 2);
270     strcpy (NewFilename, InputFilename);
271 
272     /* Try to find the last dot in the filename */
273 
274     Position = strrchr (NewFilename, '.');
275     if (Position)
276     {
277         /* Tack on the new suffix */
278 
279         Position++;
280         *Position = 0;
281         strcat (Position, Suffix);
282     }
283     else
284     {
285         /* No dot, add one and then the suffix */
286 
287         strcat (NewFilename, ".");
288         strcat (NewFilename, Suffix);
289     }
290 
291     return NewFilename;
292 }
293 
294 
295 /*******************************************************************************
296  *
297  * FUNCTION:    FlStrdup
298  *
299  * DESCRIPTION: Local strdup function
300  *
301  ******************************************************************************/
302 
303 static char *
304 FlStrdup (
305     char                *String)
306 {
307     char                *NewString;
308 
309 
310     NewString = ACPI_ALLOCATE (strlen (String) + 1);
311     if (!NewString)
312     {
313         return (NULL);
314     }
315 
316     strcpy (NewString, String);
317     return (NewString);
318 }
319 
320 
321 /*******************************************************************************
322  *
323  * FUNCTION:    FlSplitInputPathname
324  *
325  * PARAMETERS:  InputFilename       - The user-specified ASL source file to be
326  *                                    compiled
327  *              OutDirectoryPath    - Where the directory path prefix is
328  *                                    returned
329  *              OutFilename         - Where the filename part is returned
330  *
331  * RETURN:      Status
332  *
333  * DESCRIPTION: Split the input path into a directory and filename part
334  *              1) Directory part used to open include files
335  *              2) Filename part used to generate output filenames
336  *
337  ******************************************************************************/
338 
339 ACPI_STATUS
340 FlSplitInputPathname (
341     char                    *InputPath,
342     char                    **OutDirectoryPath,
343     char                    **OutFilename)
344 {
345     char                    *Substring;
346     char                    *DirectoryPath;
347     char                    *Filename;
348 
349 
350     *OutDirectoryPath = NULL;
351     *OutFilename = NULL;
352 
353     if (!InputPath)
354     {
355         return (AE_OK);
356     }
357 
358     /* Get the path to the input filename's directory */
359 
360     DirectoryPath = FlStrdup (InputPath);
361     if (!DirectoryPath)
362     {
363         return (AE_NO_MEMORY);
364     }
365 
366     Substring = strrchr (DirectoryPath, '\\');
367     if (!Substring)
368     {
369         Substring = strrchr (DirectoryPath, '/');
370         if (!Substring)
371         {
372             Substring = strrchr (DirectoryPath, ':');
373         }
374     }
375 
376     if (!Substring)
377     {
378         DirectoryPath[0] = 0;
379         Filename = FlStrdup (InputPath);
380     }
381     else
382     {
383         Filename = FlStrdup (Substring + 1);
384         *(Substring+1) = 0;
385     }
386 
387     if (!Filename)
388     {
389         return (AE_NO_MEMORY);
390     }
391 
392     *OutDirectoryPath = DirectoryPath;
393     *OutFilename = Filename;
394 
395     return (AE_OK);
396 }
397 
398 
399