Merge branch 'vendor/DHCPCD'
[dragonfly.git] / sys / contrib / dev / acpica / source / compiler / aslstartup.c
1 /******************************************************************************
2  *
3  * Module Name: aslstartup - Compiler startup routines, called from main
4  *
5  *****************************************************************************/
6
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2019, 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 "aslcompiler.h"
153 #include "actables.h"
154 #include "acdisasm.h"
155 #include "acapps.h"
156 #include "acconvert.h"
157
158 #define _COMPONENT          ACPI_COMPILER
159         ACPI_MODULE_NAME    ("aslstartup")
160
161
162 /* Local prototypes */
163
164 static UINT8
165 AslDetectSourceFileType (
166     ASL_FILE_INFO           *Info);
167
168
169 /* Globals */
170
171 static BOOLEAN          AslToFile = TRUE;
172
173
174 /*******************************************************************************
175  *
176  * FUNCTION:    AslInitializeGlobals
177  *
178  * PARAMETERS:  None
179  *
180  * RETURN:      None
181  *
182  * DESCRIPTION: Re-initialize globals needed to restart the compiler. This
183  *              allows multiple files to be disassembled and/or compiled.
184  *
185  ******************************************************************************/
186
187 void
188 AslInitializeGlobals (
189     void)
190 {
191     UINT32                  i;
192
193
194     /* Init compiler globals */
195
196     AslGbl_SyntaxError = 0;
197     AslGbl_CurrentColumn = 0;
198     AslGbl_CurrentLineNumber = 1;
199     AslGbl_LogicalLineNumber = 1;
200     AslGbl_CurrentLineOffset = 0;
201     AslGbl_InputFieldCount = 0;
202     AslGbl_InputByteCount = 0;
203     AslGbl_NsLookupCount = 0;
204     AslGbl_LineBufPtr = AslGbl_CurrentLineBuffer;
205
206     AslGbl_ErrorLog = NULL;
207     AslGbl_NextError = NULL;
208     AslGbl_Signature = NULL;
209     AslGbl_FileType = 0;
210
211     AslGbl_TotalExecutableOpcodes = 0;
212     AslGbl_TotalNamedObjects = 0;
213     AslGbl_TotalKeywords = 0;
214     AslGbl_TotalParseNodes = 0;
215     AslGbl_TotalMethods = 0;
216     AslGbl_TotalAllocations = 0;
217     AslGbl_TotalAllocated = 0;
218     AslGbl_TotalFolds = 0;
219
220     AslGbl_NextEvent = 0;
221     for (i = 0; i < ASL_NUM_REPORT_LEVELS; i++)
222     {
223         AslGbl_ExceptionCount[i] = 0;
224     }
225
226     if (AcpiGbl_CaptureComments)
227     {
228         AslGbl_CommentState.SpacesBefore          = 0;
229         AslGbl_CommentState.CommentType           = 1;
230         AslGbl_CommentState.LatestParseOp         = NULL;
231         AslGbl_CommentState.ParsingParenBraceNode = NULL;
232         AslGbl_CommentState.CaptureComments       = TRUE;
233     }
234 }
235
236
237 /*******************************************************************************
238  *
239  * FUNCTION:    AslDetectSourceFileType
240  *
241  * PARAMETERS:  Info            - Name/Handle for the file (must be open)
242  *
243  * RETURN:      File Type
244  *
245  * DESCRIPTION: Determine the type of the input file. Either binary (contains
246  *              non-ASCII characters), ASL file, or an ACPI Data Table file.
247  *
248  ******************************************************************************/
249
250 static UINT8
251 AslDetectSourceFileType (
252     ASL_FILE_INFO           *Info)
253 {
254     char                    *FileChar;
255     UINT8                   Type = ASL_INPUT_TYPE_ASCII_DATA; /* default */
256     ACPI_STATUS             Status;
257
258
259     /* Check for 100% ASCII source file (comments are ignored) */
260
261     Status = FlIsFileAsciiSource (Info->Filename, FALSE);
262     if (ACPI_SUCCESS (Status))
263     {
264         /*
265          * File contains ASCII source code. Determine if this is an ASL
266          * file or an ACPI data table file.
267          */
268         while (fgets (AslGbl_CurrentLineBuffer, AslGbl_LineBufferSize, Info->Handle))
269         {
270             /* Uppercase the buffer for caseless compare */
271
272             FileChar = AslGbl_CurrentLineBuffer;
273             while (*FileChar)
274             {
275                 *FileChar = (char) toupper ((int) *FileChar);
276                 FileChar++;
277             }
278
279             /* Presence of "DefinitionBlock" indicates actual ASL code */
280
281             if (strstr (AslGbl_CurrentLineBuffer, "DEFINITIONBLOCK"))
282             {
283                 /* Appears to be an ASL file */
284
285                 Type = ASL_INPUT_TYPE_ASCII_ASL;
286                 goto Cleanup;
287             }
288         }
289
290         /* Appears to be an ASCII data table source file */
291
292         Type = ASL_INPUT_TYPE_ASCII_DATA;
293         goto Cleanup;
294     }
295
296     /* We have some sort of binary table, check for valid ACPI table */
297
298     fseek (Info->Handle, 0, SEEK_SET);
299
300     Status = AcValidateTableHeader (Info->Handle, 0);
301     if (ACPI_SUCCESS (Status))
302     {
303         fprintf (stderr,
304             "Binary file appears to be a valid ACPI table, disassembling\n");
305
306         Type = ASL_INPUT_TYPE_BINARY_ACPI_TABLE;
307         goto Cleanup;
308     }
309     else
310     {
311         fprintf (stderr,
312             "Binary file does not contain a valid ACPI table\n");
313     }
314
315     Type = ASL_INPUT_TYPE_BINARY;
316
317
318 Cleanup:
319
320     /* Must seek back to the start of the file */
321
322     fseek (Info->Handle, 0, SEEK_SET);
323     return (Type);
324 }
325
326
327 /*******************************************************************************
328  *
329  * FUNCTION:    AslDoDisassembly
330  *
331  * PARAMETERS:  None
332  *
333  * RETURN:      Status
334  *
335  * DESCRIPTION: Initiate AML file disassembly. Uses ACPICA subsystem to build
336  *              namespace. This function assumes that the ACPI subsystem has
337  *              been initialized. The caller of the initialization will also
338  *              terminate the ACPI subsystem.
339  *
340  ******************************************************************************/
341
342 ACPI_STATUS
343 AslDoDisassembly (
344     void)
345 {
346     ACPI_STATUS             Status;
347
348
349     Status = AcpiAllocateRootTable (4);
350     if (ACPI_FAILURE (Status))
351     {
352         AcpiOsPrintf ("Could not initialize ACPI Table Manager, %s\n",
353             AcpiFormatException (Status));
354         return (Status);
355     }
356
357     /* This is where the disassembly happens */
358
359     AcpiGbl_DmOpt_Disasm = TRUE;
360     Status = AdAmlDisassemble (AslToFile,
361         AslGbl_Files[ASL_FILE_INPUT].Filename, AslGbl_OutputFilenamePrefix,
362         &AslGbl_Files[ASL_FILE_INPUT].Filename);
363     if (ACPI_FAILURE (Status))
364     {
365         return (Status);
366     }
367
368     /* Check if any control methods were unresolved */
369
370     AcpiDmUnresolvedWarning (0);
371
372     /* Clear Error log */
373
374     AeClearErrorLog ();
375
376     /*
377      * AslGbl_Files[ASL_FILE_INPUT].Filename was replaced with the
378      * .DSL disassembly file, which can now be compiled if requested
379      */
380     if (AslGbl_DoCompile)
381     {
382         AcpiOsPrintf ("\nCompiling \"%s\"\n",
383             AslGbl_Files[ASL_FILE_INPUT].Filename);
384         return (AE_CTRL_CONTINUE);
385     }
386
387     return (AE_OK);
388 }
389
390
391 /*******************************************************************************
392  *
393  * FUNCTION:    AslDoOneFile
394  *
395  * PARAMETERS:  Filename        - Name of the file
396  *
397  * RETURN:      Status
398  *
399  * DESCRIPTION: Process a single file - either disassemble, compile, or both
400  *
401  ******************************************************************************/
402
403 ACPI_STATUS
404 AslDoOneFile (
405     char                    *Filename)
406 {
407     ACPI_STATUS             Status;
408     UINT8                   Event;
409     ASL_GLOBAL_FILE_NODE    *FileNode;
410
411
412     /* Re-initialize "some" compiler/preprocessor globals */
413
414     AslInitializeGlobals ();
415     PrInitializeGlobals ();
416
417     /*
418      * Extract the directory path. This path is used for possible include
419      * files and the optional AML filename embedded in the input file
420      * DefinitionBlock declaration.
421      */
422     Status = FlSplitInputPathname (Filename, &AslGbl_DirectoryPath, NULL);
423     if (ACPI_FAILURE (Status))
424     {
425         return (Status);
426     }
427
428     /*
429      * There was an input file detected at this point. Each input ASL file is
430      * associated with one global file node consisting of the input file and
431      * all output files associated with it. This is useful when compiling
432      * multiple files in one command.
433      */
434     Status = FlInitOneFile(Filename);
435     if (ACPI_FAILURE (Status))
436     {
437         return (AE_ERROR);
438     }
439
440     /* Take a copy of the input filename, convert any backslashes */
441
442     AslGbl_Files[ASL_FILE_INPUT].Filename =
443         UtLocalCacheCalloc (strlen (Filename) + 1);
444
445     strcpy (AslGbl_Files[ASL_FILE_INPUT].Filename, Filename);
446     UtConvertBackslashes (AslGbl_Files[ASL_FILE_INPUT].Filename);
447
448     /*
449      * Open the input file. Here, this should be an ASCII source file,
450      * either an ASL file or a Data Table file
451      */
452     Status = FlOpenInputFile (AslGbl_Files[ASL_FILE_INPUT].Filename);
453     if (ACPI_FAILURE (Status))
454     {
455         AePrintErrorLog (ASL_FILE_STDERR);
456         return (AE_ERROR);
457     }
458
459     FileNode = FlGetCurrentFileNode();
460     if (!FileNode)
461     {
462         return (AE_ERROR);
463     }
464
465     FileNode->OriginalInputFileSize = FlGetFileSize (ASL_FILE_INPUT);
466
467     /* Determine input file type */
468
469     AslGbl_FileType = AslDetectSourceFileType (&AslGbl_Files[ASL_FILE_INPUT]);
470     if (AslGbl_FileType == ASL_INPUT_TYPE_BINARY)
471     {
472         return (AE_ERROR);
473     }
474
475     /*
476      * If -p not specified, we will use the input filename as the
477      * output filename prefix
478      */
479     if (AslGbl_UseDefaultAmlFilename)
480     {
481         AslGbl_OutputFilenamePrefix = AslGbl_Files[ASL_FILE_INPUT].Filename;
482     }
483
484     /*
485      * Open the output file. Note: by default, the name of this file comes from
486      * the table descriptor within the input file.
487      */
488     if (AslGbl_FileType == ASL_INPUT_TYPE_ASCII_ASL)
489     {
490         Event = UtBeginEvent ("Open AML output file");
491         Status = FlOpenAmlOutputFile (AslGbl_OutputFilenamePrefix);
492         UtEndEvent (Event);
493         if (ACPI_FAILURE (Status))
494         {
495             AePrintErrorLog (ASL_FILE_STDERR);
496             return (AE_ERROR);
497         }
498     }
499
500     /* Open the optional output files (listings, etc.) */
501
502     Status = FlOpenMiscOutputFiles (AslGbl_OutputFilenamePrefix);
503     if (ACPI_FAILURE (Status))
504     {
505         AePrintErrorLog (ASL_FILE_STDERR);
506         return (AE_ERROR);
507     }
508
509     /*
510      * Compilation of ASL source versus DataTable source uses different
511      * compiler subsystems
512      */
513     switch (AslGbl_FileType)
514     {
515     /*
516      * Data Table Compilation
517      */
518     case ASL_INPUT_TYPE_ASCII_DATA:
519
520         Status = DtDoCompile ();
521         if (ACPI_FAILURE (Status))
522         {
523             return (Status);
524         }
525
526         if (AslGbl_Signature)
527         {
528             AslGbl_Signature = NULL;
529         }
530
531         /* Check if any errors occurred during compile */
532
533         Status = AslCheckForErrorExit ();
534         if (ACPI_FAILURE (Status))
535         {
536             return (Status);
537         }
538
539         /* Cleanup (for next source file) and exit */
540
541         AeClearErrorLog ();
542         PrTerminatePreprocessor ();
543         return (Status);
544
545     /*
546      * ASL Compilation
547      */
548     case ASL_INPUT_TYPE_ASCII_ASL:
549
550         Status = CmDoCompile ();
551         if (ACPI_FAILURE (Status))
552         {
553             PrTerminatePreprocessor ();
554             return (Status);
555         }
556
557         /*
558          * At this point, we know how many lines are in the input file. Save it
559          * to display for post-compilation summary.
560          */
561         FileNode->TotalLineCount = AslGbl_CurrentLineNumber;
562         return (AE_OK);
563
564     /*
565      * Binary ACPI table was auto-detected, disassemble it
566      */
567     case ASL_INPUT_TYPE_BINARY_ACPI_TABLE:
568
569         /* We have what appears to be an ACPI table, disassemble it */
570
571         FlCloseFile (ASL_FILE_INPUT);
572         AslGbl_DoCompile = FALSE;
573         AcpiGbl_DisasmFlag = TRUE;
574         Status = AslDoDisassembly ();
575         return (Status);
576
577     /* Unknown binary table */
578
579     case ASL_INPUT_TYPE_BINARY:
580
581         AePrintErrorLog (ASL_FILE_STDERR);
582         return (AE_ERROR);
583
584     default:
585
586         printf ("Unknown file type %X\n", AslGbl_FileType);
587         return (AE_ERROR);
588     }
589 }
590
591
592 /*******************************************************************************
593  *
594  * FUNCTION:    AslCheckForErrorExit
595  *
596  * PARAMETERS:  None. Examines global exception count array
597  *
598  * RETURN:      Status
599  *
600  * DESCRIPTION: Determine if compiler should abort with error status
601  *
602  ******************************************************************************/
603
604 ACPI_STATUS
605 AslCheckForErrorExit (
606     void)
607 {
608
609     /*
610      * Return non-zero exit code if there have been errors, unless the
611      * global ignore error flag has been set
612      */
613     if (!AslGbl_IgnoreErrors)
614     {
615         if (AslGbl_ExceptionCount[ASL_ERROR] > 0)
616         {
617             return (AE_ERROR);
618         }
619
620         /* Optionally treat warnings as errors */
621
622         if (AslGbl_WarningsAsErrors)
623         {
624             if ((AslGbl_ExceptionCount[ASL_WARNING] > 0)  ||
625                 (AslGbl_ExceptionCount[ASL_WARNING2] > 0) ||
626                 (AslGbl_ExceptionCount[ASL_WARNING3] > 0))
627             {
628                 AslError (ASL_ERROR, ASL_MSG_WARNING_AS_ERROR, NULL,
629                     "(reporting warnings as errors)");
630                 return (AE_ERROR);
631             }
632         }
633     }
634
635     return (AE_OK);
636 }