xref: /netbsd-src/sys/external/bsd/acpica/dist/compiler/aslglobal.h (revision bdc22b2e01993381dcefeff2bc9b56ca75a4235c)
1 /******************************************************************************
2  *
3  * Module Name: aslglobal.h - Global variable definitions
4  *
5  *****************************************************************************/
6 
7 /*
8  * Copyright (C) 2000 - 2018, Intel Corp.
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions, and the following disclaimer,
16  *    without modification.
17  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18  *    substantially similar to the "NO WARRANTY" disclaimer below
19  *    ("Disclaimer") and any redistribution must be conditioned upon
20  *    including a substantially similar Disclaimer requirement for further
21  *    binary redistribution.
22  * 3. Neither the names of the above-listed copyright holders nor the names
23  *    of any contributors may be used to endorse or promote products derived
24  *    from this software without specific prior written permission.
25  *
26  * Alternatively, this software may be distributed under the terms of the
27  * GNU General Public License ("GPL") version 2 as published by the Free
28  * Software Foundation.
29  *
30  * NO WARRANTY
31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41  * POSSIBILITY OF SUCH DAMAGES.
42  */
43 
44 #ifndef __ASLGLOBAL_H
45 #define __ASLGLOBAL_H
46 
47 
48 /*
49  * Global variables. Defined in aslmain.c only, externed in all other files
50  */
51 
52 #undef ASL_EXTERN
53 
54 #ifdef _DECLARE_GLOBALS
55 #define ASL_EXTERN
56 #define ASL_INIT_GLOBAL(a,b)        (a)=(b)
57 #else
58 #define ASL_EXTERN                  extern
59 #define ASL_INIT_GLOBAL(a,b)        (a)
60 #endif
61 
62 
63 #ifdef _DECLARE_GLOBALS
64 UINT32                              Gbl_ExceptionCount[ASL_NUM_REPORT_LEVELS] = {0,0,0,0,0,0};
65 
66 /* Table below must match ASL_FILE_TYPES in asltypes.h */
67 
68 ASL_FILE_INFO                       Gbl_Files [ASL_NUM_FILES] =
69 {
70     {NULL, NULL, "stdout:       ", "Standard Output"},
71     {NULL, NULL, "stderr:       ", "Standard Error"},
72     {NULL, NULL, "Table Input:  ", "Source Input"},
73     {NULL, NULL, "Binary Output:", "AML Output"},
74     {NULL, NULL, "Source Output:", "Source Output"},
75     {NULL, NULL, "Preprocessor: ", "Preprocessor Output"},
76     {NULL, NULL, "Preprocessor: ", "Preprocessor Temp File"},
77     {NULL, NULL, "Listing File: ", "Listing Output"},
78     {NULL, NULL, "Hex Dump:     ", "Hex Table Output"},
79     {NULL, NULL, "Namespace:    ", "Namespace Output"},
80     {NULL, NULL, "Debug File:   ", "Debug Output"},
81     {NULL, NULL, "ASM Source:   ", "Assembly Code Output"},
82     {NULL, NULL, "C Source:     ", "C Code Output"},
83     {NULL, NULL, "ASM Include:  ", "Assembly Header Output"},
84     {NULL, NULL, "C Include:    ", "C Header Output"},
85     {NULL, NULL, "Offset Table: ", "C Offset Table Output"},
86     {NULL, NULL, "Device Map:   ", "Device Map Output"},
87     {NULL, NULL, "Cross Ref:    ", "Cross-reference Output"},
88     {NULL, NULL, "Converter db :", "Converter debug Output"}
89 };
90 
91 /* Table below must match the defines with the same names in actypes.h */
92 
93 const char                          *Gbl_OpFlagNames[ACPI_NUM_OP_FLAGS] =
94 {
95     "OP_VISITED",
96     "OP_AML_PACKAGE",
97     "OP_IS_TARGET",
98     "OP_IS_RESOURCE_DESC",
99     "OP_IS_RESOURCE_FIELD",
100     "OP_HAS_NO_EXIT",
101     "OP_IF_HAS_NO_EXIT",
102     "OP_NAME_INTERNALIZED",
103     "OP_METHOD_NO_RETVAL",
104     "OP_METHOD_SOME_NO_RETVAL",
105     "OP_RESULT_NOT_USED",
106     "OP_METHOD_TYPED",
107     "OP_COULD_NOT_REDUCE",
108     "OP_COMPILE_TIME_CONST",
109     "OP_IS_TERM_ARG",
110     "OP_WAS_ONES_OP",
111     "OP_IS_NAME_DECLARATION",
112     "OP_COMPILER_EMITTED",
113     "OP_IS_DUPLICATE",
114     "OP_IS_RESOURCE_DATA",
115     "OP_IS_NULL_RETURN",
116     "OP_NOT_FOUND_DURING_LOAD"
117 };
118 
119 #else
120 extern UINT32                       Gbl_ExceptionCount[ASL_NUM_REPORT_LEVELS];
121 extern ASL_FILE_INFO                Gbl_Files [ASL_NUM_FILES];
122 extern const char                   *Gbl_OpFlagNames[ACPI_NUM_OP_FLAGS];
123 #endif
124 
125 
126 /*
127  * Parser and other externals
128  */
129 extern int                          yydebug;
130 extern FILE                         *AslCompilerin;
131 extern int                          DtParserdebug;
132 extern int                          PrParserdebug;
133 extern const ASL_MAPPING_ENTRY      AslKeywordMapping[];
134 extern char                         *AslCompilertext;
135 
136 /*
137  * Older versions of Bison won't emit this external in the generated header.
138  * Newer versions do emit the external, so we don't need to do it.
139  */
140 #ifndef ASLCOMPILER_ASLCOMPILERPARSE_H
141 extern int                  AslCompilerdebug;
142 #endif
143 
144 
145 #define ASL_DEFAULT_LINE_BUFFER_SIZE    (1024 * 32) /* 32K */
146 #define ASL_MSG_BUFFER_SIZE             (1024 * 32) /* 32k */
147 #define ASL_MAX_DISABLED_MESSAGES       32
148 #define ASL_MAX_EXPECTED_MESSAGES       32
149 #define HEX_TABLE_LINE_SIZE             8
150 #define HEX_LISTING_LINE_SIZE           8
151 
152 
153 /* Source code buffers and pointers for error reporting */
154 
155 ASL_EXTERN char                     ASL_INIT_GLOBAL (*Gbl_CurrentLineBuffer, NULL);
156 ASL_EXTERN char                     ASL_INIT_GLOBAL (*Gbl_LineBufPtr, NULL);
157 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (Gbl_LineBufferSize, ASL_DEFAULT_LINE_BUFFER_SIZE);
158 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (Gbl_CurrentColumn, 0);
159 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (Gbl_CurrentLineNumber, 1);
160 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (Gbl_LogicalLineNumber, 1);
161 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (Gbl_CurrentLineOffset, 0);
162 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (Gbl_OriginalInputFileSize, 0);
163 ASL_EXTERN UINT8                    ASL_INIT_GLOBAL (Gbl_SyntaxError, 0);
164 
165 /* Exception reporting */
166 
167 ASL_EXTERN ASL_ERROR_MSG            ASL_INIT_GLOBAL (*Gbl_ErrorLog,NULL);
168 ASL_EXTERN ASL_ERROR_MSG            ASL_INIT_GLOBAL (*Gbl_NextError,NULL);
169 
170 /* Option flags */
171 
172 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_DoCompile, TRUE);
173 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_DoSignon, TRUE);
174 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_PreprocessOnly, FALSE);
175 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_PreprocessFlag, TRUE);
176 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_DisassembleAll, FALSE);
177 
178 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_UseDefaultAmlFilename, TRUE);
179 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_MapfileFlag, FALSE);
180 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_NsOutputFlag, FALSE);
181 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_PreprocessorOutputFlag, FALSE);
182 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_KeepPreprocessorTempFile, FALSE);
183 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_DebugFlag, FALSE);
184 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_CrossReferenceOutput, FALSE);
185 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_AsmOutputFlag, FALSE);
186 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_C_OutputFlag, FALSE);
187 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_C_OffsetTableFlag, FALSE);
188 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_AsmIncludeOutputFlag, FALSE);
189 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_C_IncludeOutputFlag, FALSE);
190 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_ListingFlag, FALSE);
191 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_IgnoreErrors, FALSE);
192 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_SourceOutputFlag, FALSE);
193 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_ParseOnlyFlag, FALSE);
194 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_CompileTimesFlag, FALSE);
195 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_FoldConstants, TRUE);
196 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_VerboseErrors, TRUE);
197 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_NoErrors, FALSE);
198 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_WarningsAsErrors, FALSE);
199 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_NoResourceChecking, FALSE);
200 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_IntegerOptimizationFlag, TRUE);
201 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_ReferenceOptimizationFlag, TRUE);
202 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_DisplayRemarks, TRUE);
203 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_DisplayWarnings, TRUE);
204 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_DisplayOptimizations, FALSE);
205 ASL_EXTERN UINT8                    ASL_INIT_GLOBAL (Gbl_WarningLevel, ASL_WARNING);
206 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_UseOriginalCompilerId, FALSE);
207 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_VerboseTemplates, FALSE);
208 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_DoTemplates, FALSE);
209 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_CompileGeneric, FALSE);
210 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_AllExceptionsDisabled, FALSE);
211 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_PruneParseTree, FALSE);
212 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_DoTypechecking, TRUE);
213 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_EnableReferenceTypechecking, FALSE);
214 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_DoExternals, TRUE);
215 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_DoExternalsInPlace, FALSE);
216 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_DoAslConversion, FALSE);
217 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_OptimizeTrivialParseNodes, TRUE);
218 
219 
220 #define HEX_OUTPUT_NONE             0
221 #define HEX_OUTPUT_C                1
222 #define HEX_OUTPUT_ASM              2
223 #define HEX_OUTPUT_ASL              3
224 
225 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_HexOutputFlag, HEX_OUTPUT_NONE);
226 
227 
228 /* Files */
229 
230 ASL_EXTERN char                     *Gbl_DirectoryPath;
231 ASL_EXTERN char                     ASL_INIT_GLOBAL (*Gbl_IncludeFilename, NULL);
232 ASL_EXTERN char                     ASL_INIT_GLOBAL (*Gbl_OutputFilenamePrefix, NULL);
233 ASL_EXTERN ASL_INCLUDE_DIR          ASL_INIT_GLOBAL (*Gbl_IncludeDirList, NULL);
234 ASL_EXTERN char                     *Gbl_CurrentInputFilename;
235 ASL_EXTERN char                     ASL_INIT_GLOBAL (*Gbl_ExternalRefFilename, NULL);
236 ASL_EXTERN char                     ASL_INIT_GLOBAL (*Gbl_PreviousIncludeFilename, NULL);
237 
238 ASL_EXTERN BOOLEAN                  ASL_INIT_GLOBAL (Gbl_HasIncludeFiles, FALSE);
239 
240 
241 /* Statistics */
242 
243 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (Gbl_InputByteCount, 0);
244 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (Gbl_InputFieldCount, 0);
245 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (Gbl_NsLookupCount, 0);
246 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (TotalKeywords, 0);
247 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (TotalNamedObjects, 0);
248 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (TotalExecutableOpcodes, 0);
249 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (TotalParseNodes, 0);
250 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (TotalMethods, 0);
251 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (TotalAllocations, 0);
252 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (TotalAllocated, 0);
253 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (TotalFolds, 0);
254 
255 
256 /* Local caches */
257 
258 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (Gbl_ParseOpCount, 0);
259 ASL_EXTERN ASL_CACHE_INFO           ASL_INIT_GLOBAL (*Gbl_ParseOpCacheList, NULL);
260 ASL_EXTERN ACPI_PARSE_OBJECT        ASL_INIT_GLOBAL (*Gbl_ParseOpCacheNext, NULL);
261 ASL_EXTERN ACPI_PARSE_OBJECT        ASL_INIT_GLOBAL (*Gbl_ParseOpCacheLast, NULL);
262 
263 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (Gbl_StringCount, 0);
264 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (Gbl_StringSize, 0);
265 ASL_EXTERN ASL_CACHE_INFO           ASL_INIT_GLOBAL (*Gbl_StringCacheList, NULL);
266 ASL_EXTERN char                     ASL_INIT_GLOBAL (*Gbl_StringCacheNext, NULL);
267 ASL_EXTERN char                     ASL_INIT_GLOBAL (*Gbl_StringCacheLast, NULL);
268 
269 /* Map file */
270 
271 ASL_EXTERN ACPI_GPIO_INFO           ASL_INIT_GLOBAL (*Gbl_GpioList, NULL);
272 ASL_EXTERN ACPI_SERIAL_INFO         ASL_INIT_GLOBAL (*Gbl_SerialList, NULL);
273 
274 
275 /* Misc */
276 
277 ASL_EXTERN UINT8                    ASL_INIT_GLOBAL (Gbl_RevisionOverride, 0);
278 ASL_EXTERN UINT8                    ASL_INIT_GLOBAL (Gbl_TempCount, 0);
279 ASL_EXTERN ACPI_PARSE_OBJECT        ASL_INIT_GLOBAL (*Gbl_ParseTreeRoot, NULL);
280 ASL_EXTERN ACPI_PARSE_OBJECT        ASL_INIT_GLOBAL (*Gbl_ExternalsListHead, NULL);
281 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (Gbl_TableLength, 0);
282 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (Gbl_SourceLine, 0);
283 ASL_EXTERN ASL_LISTING_NODE         ASL_INIT_GLOBAL (*Gbl_ListingNode, NULL);
284 ASL_EXTERN UINT8                    ASL_INIT_GLOBAL (Gbl_FileType, 0);
285 ASL_EXTERN char                     ASL_INIT_GLOBAL (*Gbl_Signature, NULL);
286 
287 ASL_EXTERN ACPI_PARSE_OBJECT        *Gbl_FirstLevelInsertionNode;
288 
289 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (Gbl_CurrentHexColumn, 0);
290 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (Gbl_CurrentAmlOffset, 0);
291 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (Gbl_CurrentLine, 0);
292 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (Gbl_DisabledMessagesIndex, 0);
293 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (Gbl_ExpectedMessagesIndex, 0);
294 ASL_EXTERN UINT8                    ASL_INIT_GLOBAL (Gbl_HexBytesWereWritten, FALSE);
295 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (Gbl_NumNamespaceObjects, 0);
296 ASL_EXTERN UINT32                   ASL_INIT_GLOBAL (Gbl_ReservedMethods, 0);
297 ASL_EXTERN char                     ASL_INIT_GLOBAL (*Gbl_TableSignature, "NO_SIG");
298 ASL_EXTERN char                     ASL_INIT_GLOBAL (*Gbl_TableId, "NO_ID");
299 ASL_EXTERN UINT8                    ASL_INIT_GLOBAL (Gbl_PruneDepth, 0);
300 ASL_EXTERN UINT16                   ASL_INIT_GLOBAL (Gbl_PruneType, 0);
301 
302 ASL_EXTERN ASL_FILE_NODE            ASL_INIT_GLOBAL (*Gbl_IncludeFileStack, NULL);
303 
304 /* Specific to the -q option */
305 
306 ASL_EXTERN ASL_COMMENT_STATE        Gbl_CommentState;
307 
308 
309 /*
310  * Determines if an inline comment should be saved in the InlineComment or NodeEndComment
311  *  field of ACPI_PARSE_OBJECT.
312  */
313 ASL_EXTERN ACPI_COMMENT_NODE        ASL_INIT_GLOBAL (*Gbl_CommentListHead, NULL);
314 ASL_EXTERN ACPI_COMMENT_NODE        ASL_INIT_GLOBAL (*Gbl_CommentListTail, NULL);
315 ASL_EXTERN char                     ASL_INIT_GLOBAL (*Gbl_InlineCommentBuffer, NULL);
316 
317 /* Static structures */
318 
319 ASL_EXTERN ASL_ANALYSIS_WALK_INFO   AnalysisWalkInfo;
320 ASL_EXTERN ACPI_TABLE_HEADER        TableHeader;
321 
322 /* Event timing */
323 
324 #define ASL_NUM_EVENTS              24
325 ASL_EXTERN ASL_EVENT_INFO           AslGbl_Events[ASL_NUM_EVENTS];
326 ASL_EXTERN UINT8                    AslGbl_NextEvent;
327 ASL_EXTERN UINT8                    AslGbl_NamespaceEvent;
328 
329 /* Scratch buffers */
330 
331 ASL_EXTERN UINT8                    Gbl_AmlBuffer[HEX_LISTING_LINE_SIZE];
332 ASL_EXTERN char                     MsgBuffer[ASL_MSG_BUFFER_SIZE];
333 ASL_EXTERN char                     StringBuffer[ASL_MSG_BUFFER_SIZE];
334 ASL_EXTERN char                     StringBuffer2[ASL_MSG_BUFFER_SIZE];
335 ASL_EXTERN UINT32                   Gbl_DisabledMessages[ASL_MAX_DISABLED_MESSAGES];
336 ASL_EXTERN ASL_EXPECTED_MESSAGE     Gbl_ExpectedMessages[ASL_MAX_EXPECTED_MESSAGES];
337 
338 
339 #endif /* __ASLGLOBAL_H */
340