xref: /freebsd/sys/contrib/dev/acpica/compiler/aslglobal.h (revision a10cee30c94cf5944826d2a495e9cdf339dfbcc8)
1 
2 
3 /******************************************************************************
4  *
5  * Module Name: aslglobal.h - Global variable definitions
6  *
7  *****************************************************************************/
8 
9 /*
10  * Copyright (C) 2000 - 2012, Intel Corp.
11  * All rights reserved.
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions
15  * are met:
16  * 1. Redistributions of source code must retain the above copyright
17  *    notice, this list of conditions, and the following disclaimer,
18  *    without modification.
19  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
20  *    substantially similar to the "NO WARRANTY" disclaimer below
21  *    ("Disclaimer") and any redistribution must be conditioned upon
22  *    including a substantially similar Disclaimer requirement for further
23  *    binary redistribution.
24  * 3. Neither the names of the above-listed copyright holders nor the names
25  *    of any contributors may be used to endorse or promote products derived
26  *    from this software without specific prior written permission.
27  *
28  * Alternatively, this software may be distributed under the terms of the
29  * GNU General Public License ("GPL") version 2 as published by the Free
30  * Software Foundation.
31  *
32  * NO WARRANTY
33  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
34  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
35  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
36  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
37  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
38  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
39  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
40  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
41  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
42  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
43  * POSSIBILITY OF SUCH DAMAGES.
44  */
45 
46 
47 #ifndef __ASLGLOBAL_H
48 #define __ASLGLOBAL_H
49 
50 
51 /*
52  * Global variables.  Defined in aslmain.c only, externed in all other files
53  */
54 
55 #undef ASL_EXTERN
56 
57 #ifdef _DECLARE_GLOBALS
58 #define ASL_EXTERN
59 #define ASL_INIT_GLOBAL(a,b)        (a)=(b)
60 #else
61 #define ASL_EXTERN                  extern
62 #define ASL_INIT_GLOBAL(a,b)        (a)
63 #endif
64 
65 
66 #ifdef _DECLARE_GLOBALS
67 UINT32                              Gbl_ExceptionCount[ASL_NUM_REPORT_LEVELS] = {0,0,0,0,0,0};
68 char                                AslHexLookup[] =
69 {
70     '0','1','2','3','4','5','6','7','8','9','A','B','C','D','E','F'
71 };
72 
73 
74 /* Table below must match ASL_FILE_TYPES in asltypes.h */
75 
76 ASL_FILE_INFO                       Gbl_Files [ASL_NUM_FILES] =
77 {
78     {NULL, NULL, "stdout:       ", "Standard Output"},
79     {NULL, NULL, "stderr:       ", "Standard Error"},
80     {NULL, NULL, "Table Input:  ", "Source Input"},
81     {NULL, NULL, "Binary Output:", "AML Output"},
82     {NULL, NULL, "Source Output:", "Source Output"},
83     {NULL, NULL, "Preprocessor: ", "Preprocessor Output"},
84     {NULL, NULL, "Listing File: ", "Listing Output"},
85     {NULL, NULL, "Hex Dump:     ", "Hex Table Output"},
86     {NULL, NULL, "Namespace:    ", "Namespace Output"},
87     {NULL, NULL, "Debug File:   ", "Debug Output"},
88     {NULL, NULL, "ASM Source:   ", "Assembly Code Output"},
89     {NULL, NULL, "C Source:     ", "C Code Output"},
90     {NULL, NULL, "ASM Include:  ", "Assembly Header Output"},
91     {NULL, NULL, "C Include:    ", "C Header Output"}
92 };
93 
94 #else
95 extern UINT32                       Gbl_ExceptionCount[ASL_NUM_REPORT_LEVELS];
96 extern char                         AslHexLookup[];
97 extern ASL_FILE_INFO                Gbl_Files [ASL_NUM_FILES];
98 #endif
99 
100 
101 /*
102  * Parser and other externals
103  */
104 extern int                          yydebug;
105 extern FILE                         *AslCompilerin;
106 extern int                          AslCompilerdebug;
107 extern int                          DtParserdebug;
108 extern int                          PrParserdebug;
109 extern const ASL_MAPPING_ENTRY      AslKeywordMapping[];
110 extern char                         *AslCompilertext;
111 
112 #define ASL_DEFAULT_LINE_BUFFER_SIZE    (1024 * 32) /* 32K */
113 #define ASL_MSG_BUFFER_SIZE             4096
114 #define HEX_TABLE_LINE_SIZE             8
115 #define HEX_LISTING_LINE_SIZE           8
116 
117 
118 /* Source code buffers and pointers for error reporting */
119 
120 ASL_EXTERN char                     ASL_INIT_GLOBAL (*Gbl_CurrentLineBuffer, NULL);
121 ASL_EXTERN char                     ASL_INIT_GLOBAL (*Gbl_LineBufPtr, NULL);
122 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (Gbl_LineBufferSize, ASL_DEFAULT_LINE_BUFFER_SIZE);
123 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (Gbl_CurrentColumn, 0);
124 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (Gbl_PreviousLineNumber, 0);
125 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (Gbl_CurrentLineNumber, 1);
126 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (Gbl_LogicalLineNumber, 1);
127 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (Gbl_CurrentLineOffset, 0);
128 
129 /* Exception reporting */
130 
131 ASL_EXTERN ASL_ERROR_MSG            ASL_INIT_GLOBAL (*Gbl_ErrorLog,NULL);
132 ASL_EXTERN ASL_ERROR_MSG            ASL_INIT_GLOBAL (*Gbl_NextError,NULL);
133 
134 /* Option flags */
135 
136 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_DoCompile, TRUE);
137 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_DoSignon, TRUE);
138 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_PreprocessOnly, FALSE);
139 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_PreprocessFlag, TRUE);
140 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_DisassembleAll, FALSE);
141 
142 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_Acpi2, FALSE);
143 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_UseDefaultAmlFilename, TRUE);
144 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_NsOutputFlag, FALSE);
145 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_PreprocessorOutputFlag, FALSE);
146 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_DebugFlag, FALSE);
147 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_AsmOutputFlag, FALSE);
148 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_C_OutputFlag, FALSE);
149 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_AsmIncludeOutputFlag, FALSE);
150 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_C_IncludeOutputFlag, FALSE);
151 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_ListingFlag, FALSE);
152 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_IgnoreErrors, FALSE);
153 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_SourceOutputFlag, FALSE);
154 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_ParseOnlyFlag, FALSE);
155 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_CompileTimesFlag, FALSE);
156 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_FoldConstants, TRUE);
157 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_VerboseErrors, TRUE);
158 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_NoErrors, FALSE);
159 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_WarningsAsErrors, FALSE);
160 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_NoResourceChecking, FALSE);
161 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_DisasmFlag, FALSE);
162 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_GetAllTables, FALSE);
163 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_IntegerOptimizationFlag, TRUE);
164 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_ReferenceOptimizationFlag, TRUE);
165 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_DisplayRemarks, TRUE);
166 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_DisplayOptimizations, FALSE);
167 ASL_EXTERN UINT8                    ASL_INIT_GLOBAL (Gbl_WarningLevel, ASL_WARNING);
168 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_UseOriginalCompilerId, FALSE);
169 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_VerboseTemplates, FALSE);
170 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_DoTemplates, FALSE);
171 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_CompileGeneric, FALSE);
172 
173 
174 #define HEX_OUTPUT_NONE             0
175 #define HEX_OUTPUT_C                1
176 #define HEX_OUTPUT_ASM              2
177 #define HEX_OUTPUT_ASL              3
178 
179 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_HexOutputFlag, HEX_OUTPUT_NONE);
180 
181 
182 /* Files */
183 
184 ASL_EXTERN char                     *Gbl_DirectoryPath;
185 ASL_EXTERN char                     ASL_INIT_GLOBAL (*Gbl_IncludeFilename, NULL);
186 ASL_EXTERN char                     ASL_INIT_GLOBAL (*Gbl_OutputFilenamePrefix, NULL);
187 ASL_EXTERN ASL_INCLUDE_DIR          ASL_INIT_GLOBAL (*Gbl_IncludeDirList, NULL);
188 ASL_EXTERN char                     *Gbl_CurrentInputFilename;
189 
190 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_HasIncludeFiles, FALSE);
191 
192 
193 /* Statistics */
194 
195 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (Gbl_InputByteCount, 0);
196 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (Gbl_InputFieldCount, 0);
197 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (Gbl_NsLookupCount, 0);
198 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (TotalKeywords, 0);
199 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (TotalNamedObjects, 0);
200 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (TotalExecutableOpcodes, 0);
201 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (TotalParseNodes, 0);
202 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (TotalMethods, 0);
203 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (TotalAllocations, 0);
204 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (TotalAllocated, 0);
205 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (TotalFolds, 0);
206 
207 
208 /* Misc */
209 
210 ASL_EXTERN UINT8                    ASL_INIT_GLOBAL (Gbl_RevisionOverride, 0);
211 ASL_EXTERN UINT8                    ASL_INIT_GLOBAL (Gbl_TempCount, 0);
212 ASL_EXTERN ACPI_PARSE_OBJECT        ASL_INIT_GLOBAL (*RootNode, NULL);
213 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (Gbl_TableLength, 0);
214 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (Gbl_SourceLine, 0);
215 ASL_EXTERN ASL_LISTING_NODE         ASL_INIT_GLOBAL (*Gbl_ListingNode, NULL);
216 ASL_EXTERN ACPI_PARSE_OBJECT        ASL_INIT_GLOBAL (*Gbl_NodeCacheNext, NULL);
217 ASL_EXTERN ACPI_PARSE_OBJECT        ASL_INIT_GLOBAL (*Gbl_NodeCacheLast, NULL);
218 ASL_EXTERN char                     ASL_INIT_GLOBAL (*Gbl_StringCacheNext, NULL);
219 ASL_EXTERN char                     ASL_INIT_GLOBAL (*Gbl_StringCacheLast, NULL);
220 ASL_EXTERN ACPI_PARSE_OBJECT        *Gbl_FirstLevelInsertionNode;
221 ASL_EXTERN UINT8                    ASL_INIT_GLOBAL (Gbl_FileType, 0);
222 ASL_EXTERN char                     ASL_INIT_GLOBAL (*Gbl_Signature, NULL);
223 ASL_EXTERN char                     *Gbl_TemplateSignature;
224 
225 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (Gbl_CurrentHexColumn, 0);
226 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (Gbl_CurrentAmlOffset, 0);
227 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (Gbl_CurrentLine, 0);
228 ASL_EXTERN UINT8                    ASL_INIT_GLOBAL (Gbl_HexBytesWereWritten, FALSE);
229 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (Gbl_NumNamespaceObjects, 0);
230 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (Gbl_ReservedMethods, 0);
231 ASL_EXTERN char                     ASL_INIT_GLOBAL (*Gbl_TableSignature, "NO_SIG");
232 ASL_EXTERN char                     ASL_INIT_GLOBAL (*Gbl_TableId, "NO_ID");
233 ASL_EXTERN FILE                     *AcpiGbl_DebugFile; /* Placeholder for oswinxf only */
234 
235 
236 /* Static structures */
237 
238 ASL_EXTERN ASL_ANALYSIS_WALK_INFO   AnalysisWalkInfo;
239 ASL_EXTERN ACPI_TABLE_HEADER        TableHeader;
240 
241 /* Event timing */
242 
243 #define ASL_NUM_EVENTS              20
244 ASL_EXTERN ASL_EVENT_INFO           AslGbl_Events[ASL_NUM_EVENTS];
245 ASL_EXTERN UINT8                    AslGbl_NextEvent;
246 ASL_EXTERN UINT8                    AslGbl_NamespaceEvent;
247 
248 /* Scratch buffers */
249 
250 ASL_EXTERN UINT8                    Gbl_AmlBuffer[HEX_LISTING_LINE_SIZE];
251 ASL_EXTERN char                     MsgBuffer[ASL_MSG_BUFFER_SIZE];
252 ASL_EXTERN char                     StringBuffer[ASL_MSG_BUFFER_SIZE];
253 ASL_EXTERN char                     StringBuffer2[ASL_MSG_BUFFER_SIZE];
254 
255 
256 #endif /* __ASLGLOBAL_H */
257 
258