xref: /freebsd/sys/contrib/dev/acpica/compiler/aslmain.c (revision 5c831a5bd61576cacb48b39f8eeb47b92707a355)
1 /******************************************************************************
2  *
3  * Module Name: aslmain - compiler main and utilities
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2017, 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 #define _DECLARE_GLOBALS
153 
154 #include <contrib/dev/acpica/compiler/aslcompiler.h>
155 #include <contrib/dev/acpica/include/acapps.h>
156 #include <contrib/dev/acpica/include/acdisasm.h>
157 #include <signal.h>
158 
159 #define _COMPONENT          ACPI_COMPILER
160         ACPI_MODULE_NAME    ("aslmain")
161 
162 /*
163  * Main routine for the iASL compiler.
164  *
165  * Portability note: The compiler depends upon the host for command-line
166  * wildcard support - it is not implemented locally. For example:
167  *
168  * Linux/Unix systems: Shell expands wildcards automatically.
169  *
170  * Windows: The setargv.obj module must be linked in to automatically
171  * expand wildcards.
172  */
173 
174 /* Local prototypes */
175 
176 static void ACPI_SYSTEM_XFACE
177 AslSignalHandler (
178     int                     Sig);
179 
180 static void
181 AslInitialize (
182     void);
183 
184 
185 /*******************************************************************************
186  *
187  * FUNCTION:    main
188  *
189  * PARAMETERS:  Standard argc/argv
190  *
191  * RETURN:      Program termination code
192  *
193  * DESCRIPTION: C main routine for the iASL Compiler/Disassembler. Process
194  *  command line options and begin the compile/disassembly for each file on
195  *  the command line (wildcards supported).
196  *
197  ******************************************************************************/
198 
199 int ACPI_SYSTEM_XFACE
200 main (
201     int                     argc,
202     char                    **argv)
203 {
204     ACPI_STATUS             Status;
205     int                     Index1;
206     int                     Index2;
207     int                     ReturnStatus = 0;
208 
209 
210     signal (SIGINT, AslSignalHandler);
211     signal (SIGSEGV, AslSignalHandler);
212 
213     /*
214      * Big-endian machines are not currently supported. ACPI tables must
215      * be little-endian, and support for big-endian machines needs to
216      * be implemented.
217      */
218     if (UtIsBigEndianMachine ())
219     {
220         fprintf (stderr,
221             "iASL is not currently supported on big-endian machines.\n");
222         return (-1);
223     }
224 
225     AcpiOsInitialize ();
226     ACPI_DEBUG_INITIALIZE (); /* For debug version only */
227 
228     /* Initialize preprocessor and compiler before command line processing */
229 
230     AcpiGbl_ExternalFileList = NULL;
231     AcpiDbgLevel = 0;
232     PrInitializePreprocessor ();
233     AslInitialize ();
234 
235     Index1 = Index2 =
236         AslCommandLine (argc, argv);
237 
238     /* Allocate the line buffer(s), must be after command line */
239 
240     Gbl_LineBufferSize /= 2;
241     UtExpandLineBuffers ();
242 
243     /* Perform global actions first/only */
244 
245     if (Gbl_DisassembleAll)
246     {
247         while (argv[Index1])
248         {
249             Status = AcpiDmAddToExternalFileList (argv[Index1]);
250             if (ACPI_FAILURE (Status))
251             {
252                 return (-1);
253             }
254 
255             Index1++;
256         }
257     }
258 
259 
260     /* Process each pathname/filename in the list, with possible wildcards */
261 
262     while (argv[Index2])
263     {
264         /*
265          * If -p not specified, we will use the input filename as the
266          * output filename prefix
267          */
268         if (Gbl_UseDefaultAmlFilename)
269         {
270             Gbl_OutputFilenamePrefix = argv[Index2];
271             UtConvertBackslashes (Gbl_OutputFilenamePrefix);
272         }
273 
274         Status = AslDoOneFile (argv[Index2]);
275         if (ACPI_FAILURE (Status))
276         {
277             ReturnStatus = -1;
278             goto CleanupAndExit;
279         }
280 
281         Index2++;
282     }
283 
284 
285 CleanupAndExit:
286 
287     UtFreeLineBuffers ();
288     AslParserCleanup ();
289 
290     if (AcpiGbl_ExternalFileList)
291     {
292         AcpiDmClearExternalFileList();
293     }
294 
295     return (ReturnStatus);
296 }
297 
298 
299 /******************************************************************************
300  *
301  * FUNCTION:    AslSignalHandler
302  *
303  * PARAMETERS:  Sig                 - Signal that invoked this handler
304  *
305  * RETURN:      None
306  *
307  * DESCRIPTION: Signal interrupt handler. Delete any intermediate files and
308  *              any output files that may be left in an indeterminate state.
309  *              Currently handles SIGINT (control-c) and SIGSEGV (segmentation
310  *              fault).
311  *
312  *****************************************************************************/
313 
314 static void ACPI_SYSTEM_XFACE
315 AslSignalHandler (
316     int                     Sig)
317 {
318     UINT32                  i;
319 
320 
321     signal (Sig, SIG_IGN);
322     fflush (stdout);
323     fflush (stderr);
324 
325     switch (Sig)
326     {
327     case SIGINT:
328 
329         printf ("\n" ASL_PREFIX "<Control-C>\n");
330         break;
331 
332     case SIGSEGV:
333 
334         /* Even on a seg fault, we will try to delete any partial files */
335 
336         printf (ASL_PREFIX "Segmentation Fault\n");
337         break;
338 
339     default:
340 
341         printf (ASL_PREFIX "Unknown interrupt signal (%u), ignoring\n", Sig);
342         return;
343     }
344 
345     /*
346      * Close all open files
347      * Note: the .pre file is the same as the input source file
348      */
349     Gbl_Files[ASL_FILE_PREPROCESSOR].Handle = NULL;
350 
351     for (i = ASL_FILE_INPUT; i < ASL_MAX_FILE_TYPE; i++)
352     {
353         FlCloseFile (i);
354     }
355 
356     /* Delete any output files */
357 
358     for (i = ASL_FILE_AML_OUTPUT; i < ASL_MAX_FILE_TYPE; i++)
359     {
360         FlDeleteFile (i);
361     }
362 
363     printf (ASL_PREFIX "Terminating\n");
364     exit (0);
365 }
366 
367 
368 /*******************************************************************************
369  *
370  * FUNCTION:    AslInitialize
371  *
372  * PARAMETERS:  None
373  *
374  * RETURN:      None
375  *
376  * DESCRIPTION: Initialize compiler globals
377  *
378  ******************************************************************************/
379 
380 static void
381 AslInitialize (
382     void)
383 {
384     UINT32                  i;
385 
386 
387     AcpiGbl_DmOpt_Verbose = FALSE;
388 
389     /* Default integer width is 32 bits */
390 
391     AcpiGbl_IntegerBitWidth = 32;
392     AcpiGbl_IntegerNybbleWidth = 8;
393     AcpiGbl_IntegerByteWidth = 4;
394 
395     for (i = 0; i < ASL_NUM_FILES; i++)
396     {
397         Gbl_Files[i].Handle = NULL;
398         Gbl_Files[i].Filename = NULL;
399     }
400 
401     Gbl_Files[ASL_FILE_STDOUT].Handle   = stdout;
402     Gbl_Files[ASL_FILE_STDOUT].Filename = "STDOUT";
403 
404     Gbl_Files[ASL_FILE_STDERR].Handle   = stderr;
405     Gbl_Files[ASL_FILE_STDERR].Filename = "STDERR";
406 }
407