2 /******************************************************************************
4 * Module Name: aslcompile - top level compile module
7 *****************************************************************************/
9 /******************************************************************************
13 * Some or all of this work - Copyright (c) 1999 - 2007, Intel Corp.
14 * All rights reserved.
18 * 2.1. This is your license from Intel Corp. under its intellectual property
19 * rights. You may have additional license terms from the party that provided
20 * you this software, covering your right to use that party's intellectual
23 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
24 * copy of the source code appearing in this file ("Covered Code") an
25 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
26 * base code distributed originally by Intel ("Original Intel Code") to copy,
27 * make derivatives, distribute, use and display any portion of the Covered
28 * Code in any form, with the right to sublicense such rights; and
30 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
31 * license (with the right to sublicense), under only those claims of Intel
32 * patents that are infringed by the Original Intel Code, to make, use, sell,
33 * offer to sell, and import the Covered Code and derivative works thereof
34 * solely to the minimum extent necessary to exercise the above copyright
35 * license, and in no event shall the patent license extend to any additions
36 * to or modifications of the Original Intel Code. No other license or right
37 * is granted directly or by implication, estoppel or otherwise;
39 * The above copyright and patent license is granted only if the following
44 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
45 * Redistribution of source code of any substantial portion of the Covered
46 * Code or modification with rights to further distribute source must include
47 * the above Copyright Notice, the above License, this list of Conditions,
48 * and the following Disclaimer and Export Compliance provision. In addition,
49 * Licensee must cause all Covered Code to which Licensee contributes to
50 * contain a file documenting the changes Licensee made to create that Covered
51 * Code and the date of any change. Licensee must include in that file the
52 * documentation of any changes made by any predecessor Licensee. Licensee
53 * must include a prominent statement that the modification is derived,
54 * directly or indirectly, from Original Intel Code.
56 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
57 * Redistribution of source code of any substantial portion of the Covered
58 * Code or modification without rights to further distribute source must
59 * include the following Disclaimer and Export Compliance provision in the
60 * documentation and/or other materials provided with distribution. In
61 * addition, Licensee may not authorize further sublicense of source of any
62 * portion of the Covered Code, and must include terms to the effect that the
63 * license from Licensee to its licensee is limited to the intellectual
64 * property embodied in the software Licensee provides to its licensee, and
65 * not to intellectual property embodied in modifications its licensee may
68 * 3.3. Redistribution of Executable. Redistribution in executable form of any
69 * substantial portion of the Covered Code or modification must reproduce the
70 * above Copyright Notice, and the following Disclaimer and Export Compliance
71 * provision in the documentation and/or other materials provided with the
74 * 3.4. Intel retains all right, title, and interest in and to the Original
77 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
78 * Intel shall be used in advertising or otherwise to promote the sale, use or
79 * other dealings in products derived from or relating to the Covered Code
80 * without prior written authorization from Intel.
82 * 4. Disclaimer and Export Compliance
84 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
85 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
86 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
87 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
88 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
89 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
92 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
93 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
94 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
95 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
96 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
97 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
98 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
101 * 4.3. Licensee shall not export, either directly or indirectly, any of this
102 * software or system incorporating such software without first obtaining any
103 * required license or other approval from the U. S. Department of Commerce or
104 * any other agency or department of the United States Government. In the
105 * event Licensee exports any such software from the United States or
106 * re-exports any such software from a foreign destination, Licensee shall
107 * ensure that the distribution and export/re-export of the software is in
108 * compliance with all laws, regulations, orders, or other restrictions of the
109 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
110 * any of its subsidiaries will export/re-export any technical data, process,
111 * software, or service, directly or indirectly, to any country for which the
112 * United States government or any agency thereof requires an export license,
113 * other governmental approval, or letter of assurance, without first obtaining
114 * such license, approval or letter.
116 *****************************************************************************/
120 #include <contrib/dev/acpica/compiler/aslcompiler.h>
122 #define _COMPONENT ACPI_COMPILER
123 ACPI_MODULE_NAME ("aslcompile")
125 /* Local prototypes */
133 ASL_FILE_INFO *FileInfo);
136 /*******************************************************************************
138 * FUNCTION: AslCompilerSignon
140 * PARAMETERS: FileId - ID of the output file
144 * DESCRIPTION: Display compiler signon
146 ******************************************************************************/
155 /* Set line prefix depending on the destination file type */
159 case ASL_FILE_ASM_SOURCE_OUTPUT:
160 case ASL_FILE_ASM_INCLUDE_OUTPUT:
165 case ASL_FILE_HEX_OUTPUT:
167 if (Gbl_HexOutputFlag == HEX_OUTPUT_ASM)
171 else if (Gbl_HexOutputFlag == HEX_OUTPUT_C)
173 FlPrintFile (ASL_FILE_HEX_OUTPUT, "/*\n");
178 case ASL_FILE_C_SOURCE_OUTPUT:
179 case ASL_FILE_C_INCLUDE_OUTPUT:
185 /* No other output types supported */
190 * Compiler signon with copyright
198 /* Running compiler or disassembler? */
203 "%s", DisassemblerId);
211 /* Version, build date, copyright, compliance */
214 " version %X [%s]\n%s%s\n%s%s\n%s\n",
215 (UINT32) ACPI_CA_VERSION, __DATE__,
216 Prefix, CompilerCopyright,
217 Prefix, CompilerCompliance,
222 /*******************************************************************************
224 * FUNCTION: AslCompilerFileHeader
226 * PARAMETERS: FileId - ID of the output file
230 * DESCRIPTION: Header used at the beginning of output files
232 ******************************************************************************/
235 AslCompilerFileHeader (
243 /* Set line prefix depending on the destination file type */
247 case ASL_FILE_ASM_SOURCE_OUTPUT:
248 case ASL_FILE_ASM_INCLUDE_OUTPUT:
253 case ASL_FILE_HEX_OUTPUT:
255 if (Gbl_HexOutputFlag == HEX_OUTPUT_ASM)
259 else if (Gbl_HexOutputFlag == HEX_OUTPUT_C)
265 case ASL_FILE_C_SOURCE_OUTPUT:
266 case ASL_FILE_C_INCLUDE_OUTPUT:
272 /* No other output types supported */
276 /* Compilation header with timestamp */
278 (void) time (&Aclock);
279 NewTime = localtime (&Aclock);
282 "%sCompilation of \"%s\" - %s%s\n",
283 Prefix, Gbl_Files[ASL_FILE_INPUT].Filename, asctime (NewTime),
288 case ASL_FILE_C_SOURCE_OUTPUT:
289 case ASL_FILE_C_INCLUDE_OUTPUT:
290 FlPrintFile (FileId, " */\n");
294 /* Nothing to do for other output types */
300 /*******************************************************************************
302 * FUNCTION: CmFlushSourceCode
308 * DESCRIPTION: Read in any remaining source code after the parse tree
309 * has been constructed.
311 ******************************************************************************/
320 while (FlReadFile (ASL_FILE_INPUT, &Buffer, 1) != AE_ERROR)
322 InsertLineBuffer ((int) Buffer);
325 ResetCurrentLineBuffer ();
329 /*******************************************************************************
331 * FUNCTION: FlConsume*
333 * PARAMETERS: FileInfo - Points to an open input file
335 * RETURN: Number of lines consumed
337 * DESCRIPTION: Step over both types of comment during check for ascii chars
339 ******************************************************************************/
342 FlConsumeAnsiComment (
343 ASL_FILE_INFO *FileInfo,
344 ASL_FILE_STATUS *Status)
347 BOOLEAN ClosingComment = FALSE;
350 while (fread (&Byte, 1, 1, FileInfo->Handle))
352 /* Scan until comment close is found */
365 ClosingComment = FALSE;
368 else if (Byte == '*')
370 ClosingComment = TRUE;
373 /* Maintain line count */
386 FlConsumeNewComment (
387 ASL_FILE_INFO *FileInfo,
388 ASL_FILE_STATUS *Status)
393 while (fread (&Byte, 1, 1, FileInfo->Handle))
397 /* Comment ends at newline */
408 /*******************************************************************************
410 * FUNCTION: FlCheckForAscii
412 * PARAMETERS: FileInfo - Points to an open input file
416 * DESCRIPTION: Verify that the input file is entirely ASCII. Ignores characters
417 * within comments. Note: does not handle nested comments and does
418 * not handle comment delimiters within string literals. However,
419 * on the rare chance this happens and an invalid character is
420 * missed, the parser will catch the error by failing in some
421 * spectactular manner.
423 ******************************************************************************/
427 ASL_FILE_INFO *FileInfo)
430 ACPI_SIZE BadBytes = 0;
431 BOOLEAN OpeningComment = FALSE;
432 ASL_FILE_STATUS Status;
438 /* Read the entire file */
440 while (fread (&Byte, 1, 1, FileInfo->Handle))
442 /* Ignore comment fields (allow non-ascii within) */
446 /* Check for second comment open delimiter */
450 FlConsumeAnsiComment (FileInfo, &Status);
455 FlConsumeNewComment (FileInfo, &Status);
460 OpeningComment = FALSE;
462 else if (Byte == '/')
464 OpeningComment = TRUE;
467 /* Check for an ASCII character */
474 "Non-ASCII character [0x%2.2X] found in line %u, file offset 0x%.2X\n",
475 Byte, Status.Line, Status.Offset);
481 /* Update line counter */
483 else if (Byte == 0x0A)
491 /* Seek back to the beginning of the source file */
493 fseek (FileInfo->Handle, 0, SEEK_SET);
495 /* Were there any non-ASCII characters in the file? */
500 "%u non-ASCII characters found in input source text, could be a binary file\n",
502 AslError (ASL_ERROR, ASL_MSG_NON_ASCII, NULL, FileInfo->Filename);
503 return (AE_BAD_CHARACTER);
512 /*******************************************************************************
514 * FUNCTION: CmDoCompile
518 * RETURN: Status (0 = OK)
520 * DESCRIPTION: This procedure performs the entire compile
522 ******************************************************************************/
533 FullCompile = UtBeginEvent ("*** Total Compile time ***");
534 Event = UtBeginEvent ("Open input and output files");
536 /* Open the required input and output files */
538 Status = FlOpenInputFile (Gbl_Files[ASL_FILE_INPUT].Filename);
539 if (ACPI_FAILURE (Status))
541 AePrintErrorLog (ASL_FILE_STDERR);
545 /* Check for 100% ASCII source file (comments are ignored) */
547 Status = FlCheckForAscii (&Gbl_Files[ASL_FILE_INPUT]);
548 if (ACPI_FAILURE (Status))
550 AePrintErrorLog (ASL_FILE_STDERR);
554 Status = FlOpenMiscOutputFiles (Gbl_OutputFilenamePrefix);
555 if (ACPI_FAILURE (Status))
557 AePrintErrorLog (ASL_FILE_STDERR);
562 /* Build the parse tree */
564 Event = UtBeginEvent ("Parse source code and build parse tree");
568 /* Flush out any remaining source after parse tree is complete */
570 Event = UtBeginEvent ("Flush source input");
571 CmFlushSourceCode ();
573 /* Did the parse tree get successfully constructed? */
581 /* Optional parse tree dump, compiler debug output only */
585 OpcGetIntegerWidth (RootNode);
588 /* Pre-process parse tree for any operator transforms */
590 Event = UtBeginEvent ("Parse tree transforms");
591 DbgPrint (ASL_DEBUG_OUTPUT, "\nParse tree transforms\n\n");
592 TrWalkParseTree (RootNode, ASL_WALK_VISIT_DOWNWARD,
593 TrAmlTransformWalk, NULL, NULL);
596 /* Generate AML opcodes corresponding to the parse tokens */
598 Event = UtBeginEvent ("Generate AML opcodes");
599 DbgPrint (ASL_DEBUG_OUTPUT, "\nGenerating AML opcodes\n\n");
600 TrWalkParseTree (RootNode, ASL_WALK_VISIT_UPWARD, NULL,
601 OpcAmlOpcodeWalk, NULL);
605 * Now that the input is parsed, we can open the AML output file.
606 * Note: by default, the name of this file comes from the table descriptor
607 * within the input file.
609 Event = UtBeginEvent ("Open AML output file");
610 Status = FlOpenAmlOutputFile (Gbl_OutputFilenamePrefix);
611 if (ACPI_FAILURE (Status))
613 AePrintErrorLog (ASL_FILE_STDERR);
618 /* Interpret and generate all compile-time constants */
620 Event = UtBeginEvent ("Constant folding via AML interpreter");
621 DbgPrint (ASL_DEBUG_OUTPUT,
622 "\nInterpreting compile-time constant expressions\n\n");
623 TrWalkParseTree (RootNode, ASL_WALK_VISIT_DOWNWARD,
624 OpcAmlConstantWalk, NULL, NULL);
627 /* Update AML opcodes if necessary, after constant folding */
629 Event = UtBeginEvent ("Updating AML opcodes after constant folding");
630 DbgPrint (ASL_DEBUG_OUTPUT,
631 "\nUpdating AML opcodes after constant folding\n\n");
632 TrWalkParseTree (RootNode, ASL_WALK_VISIT_UPWARD,
633 NULL, OpcAmlOpcodeUpdateWalk, NULL);
636 /* Calculate all AML package lengths */
638 Event = UtBeginEvent ("Generate AML package lengths");
639 DbgPrint (ASL_DEBUG_OUTPUT, "\nGenerating Package lengths\n\n");
640 TrWalkParseTree (RootNode, ASL_WALK_VISIT_UPWARD, NULL,
641 LnPackageLengthWalk, NULL);
644 if (Gbl_ParseOnlyFlag)
646 AePrintErrorLog (ASL_FILE_STDOUT);
647 UtDisplaySummary (ASL_FILE_STDOUT);
650 /* Print error summary to the debug file */
652 AePrintErrorLog (ASL_FILE_STDERR);
653 UtDisplaySummary (ASL_FILE_STDERR);
659 * Create an internal namespace and use it as a symbol table
662 /* Namespace loading */
664 Event = UtBeginEvent ("Create ACPI Namespace");
665 Status = LdLoadNamespace (RootNode);
667 if (ACPI_FAILURE (Status))
672 /* Namespace cross-reference */
674 AslGbl_NamespaceEvent = UtBeginEvent ("Cross reference parse tree and Namespace");
675 Status = LkCrossReferenceNamespace ();
676 if (ACPI_FAILURE (Status))
681 /* Namespace - Check for non-referenced objects */
683 LkFindUnreferencedObjects ();
684 UtEndEvent (AslGbl_NamespaceEvent);
687 * Semantic analysis. This can happen only after the
688 * namespace has been loaded and cross-referenced.
690 * part one - check control methods
692 Event = UtBeginEvent ("Analyze control method return types");
693 AnalysisWalkInfo.MethodStack = NULL;
695 DbgPrint (ASL_DEBUG_OUTPUT, "\nSemantic analysis - Method analysis\n\n");
696 TrWalkParseTree (RootNode, ASL_WALK_VISIT_TWICE,
697 AnMethodAnalysisWalkBegin,
698 AnMethodAnalysisWalkEnd, &AnalysisWalkInfo);
701 /* Semantic error checking part two - typing of method returns */
703 Event = UtBeginEvent ("Determine object types returned by methods");
704 DbgPrint (ASL_DEBUG_OUTPUT, "\nSemantic analysis - Method typing\n\n");
705 TrWalkParseTree (RootNode, ASL_WALK_VISIT_TWICE,
706 AnMethodTypingWalkBegin,
707 AnMethodTypingWalkEnd, NULL);
710 /* Semantic error checking part three - operand type checking */
712 Event = UtBeginEvent ("Analyze AML operand types");
713 DbgPrint (ASL_DEBUG_OUTPUT, "\nSemantic analysis - Operand type checking\n\n");
714 TrWalkParseTree (RootNode, ASL_WALK_VISIT_TWICE,
715 AnOperandTypecheckWalkBegin,
716 AnOperandTypecheckWalkEnd, &AnalysisWalkInfo);
719 /* Semantic error checking part four - other miscellaneous checks */
721 Event = UtBeginEvent ("Miscellaneous analysis");
722 DbgPrint (ASL_DEBUG_OUTPUT, "\nSemantic analysis - miscellaneous\n\n");
723 TrWalkParseTree (RootNode, ASL_WALK_VISIT_TWICE,
724 AnOtherSemanticAnalysisWalkBegin,
725 AnOtherSemanticAnalysisWalkEnd, &AnalysisWalkInfo);
728 /* Calculate all AML package lengths */
730 Event = UtBeginEvent ("Finish AML package length generation");
731 DbgPrint (ASL_DEBUG_OUTPUT, "\nGenerating Package lengths\n\n");
732 TrWalkParseTree (RootNode, ASL_WALK_VISIT_UPWARD, NULL,
733 LnInitLengthsWalk, NULL);
734 TrWalkParseTree (RootNode, ASL_WALK_VISIT_UPWARD, NULL,
735 LnPackageLengthWalk, NULL);
738 /* Code generation - emit the AML */
740 Event = UtBeginEvent ("Generate AML code and write output files");
741 CgGenerateAmlOutput ();
744 Event = UtBeginEvent ("Write optional output files");
748 UtEndEvent (FullCompile);
754 /*******************************************************************************
756 * FUNCTION: CmDoOutputFiles
762 * DESCRIPTION: Create all "listing" type files
764 ******************************************************************************/
771 /* Create listings and hex files */
776 /* Dump the namespace to the .nsp file if requested */
778 (void) LsDisplayNamespace ();
782 /*******************************************************************************
784 * FUNCTION: CmDumpEvent
786 * PARAMETERS: Event - A compiler event struct
790 * DESCRIPTION: Dump a compiler event struct
792 ******************************************************************************/
796 ASL_EVENT_INFO *Event)
807 /* Delta will be in 100-nanosecond units */
809 Delta = (UINT32) (Event->EndTime - Event->StartTime);
812 MSec = Delta / 10000;
814 /* Round milliseconds up */
816 if ((USec - (MSec * 1000)) >= 500)
821 DbgPrint (ASL_DEBUG_OUTPUT, "%8u usec %8u msec - %s\n",
822 USec, MSec, Event->EventName);
826 /*******************************************************************************
828 * FUNCTION: CmCleanupAndExit
834 * DESCRIPTION: Close all open files and exit the compiler
836 ******************************************************************************/
845 AePrintErrorLog (ASL_FILE_STDOUT);
848 /* Print error summary to the debug file */
850 AePrintErrorLog (ASL_FILE_STDERR);
853 DbgPrint (ASL_DEBUG_OUTPUT, "\n\nElapsed time for major events\n\n");
854 for (i = 0; i < AslGbl_NextEvent; i++)
856 CmDumpEvent (&AslGbl_Events[i]);
859 if (Gbl_CompileTimesFlag)
861 printf ("\nElapsed time for major events\n\n");
862 for (i = 0; i < AslGbl_NextEvent; i++)
864 CmDumpEvent (&AslGbl_Events[i]);
867 printf ("\nMiscellaneous compile statistics\n\n");
868 printf ("%11u : %s\n", TotalParseNodes, "Parse nodes");
869 printf ("%11u : %s\n", Gbl_NsLookupCount, "Namespace searches");
870 printf ("%11u : %s\n", TotalNamedObjects, "Named objects");
871 printf ("%11u : %s\n", TotalMethods, "Control methods");
872 printf ("%11u : %s\n", TotalAllocations, "Memory Allocations");
873 printf ("%11u : %s\n", TotalAllocated, "Total allocated memory");
874 printf ("%11u : %s\n", TotalFolds, "Constant subtrees folded");
878 if (Gbl_NsLookupCount)
880 DbgPrint (ASL_DEBUG_OUTPUT, "\n\nMiscellaneous compile statistics\n\n");
881 DbgPrint (ASL_DEBUG_OUTPUT, "%32s : %d\n", "Total Namespace searches",
883 DbgPrint (ASL_DEBUG_OUTPUT, "%32s : %d usec\n", "Time per search",
884 ((UINT32) (AslGbl_Events[AslGbl_NamespaceEvent].EndTime -
885 AslGbl_Events[AslGbl_NamespaceEvent].StartTime) /
886 10) / Gbl_NsLookupCount);
889 /* Close all open files */
891 for (i = 2; i < ASL_MAX_FILE_TYPE; i++)
897 * TBD: SourceOutput should be .TMP, then rename if we want to keep it?
899 if (!Gbl_SourceOutputFlag)
901 remove (Gbl_Files[ASL_FILE_SOURCE_OUTPUT].Filename);
904 /* Delete AML file if there are errors */
906 if ((Gbl_ExceptionCount[ASL_ERROR] > 0) && (!Gbl_IgnoreErrors))
908 remove (Gbl_Files[ASL_FILE_AML_OUTPUT].Filename);
911 if (Gbl_ExceptionCount[ASL_ERROR] > ASL_MAX_ERROR_COUNT)
913 printf ("\nMaximum error count (%d) exceeded\n", ASL_MAX_ERROR_COUNT);
916 UtDisplaySummary (ASL_FILE_STDOUT);
919 * Return non-zero exit code if there have been errors, unless the
920 * global ignore error flag has been set
922 if ((Gbl_ExceptionCount[ASL_ERROR] > 0) && (!Gbl_IgnoreErrors))