1 /******************************************************************************
2  *
3  * Module Name: preprocess.h - header for iASL Preprocessor
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 #define __PREPROCESS_H__
153 
154 #ifndef _PREPROCESS
155 #define _PREPROCESS
156 
157 #undef PR_EXTERN
158 
159 #ifdef _DECLARE_PR_GLOBALS
160 #define PR_EXTERN
161 #define PR_INIT_GLOBAL(a,b)         (a)=(b)
162 #else
163 #define PR_EXTERN                   extern
164 #define PR_INIT_GLOBAL(a,b)         (a)
165 #endif
166 
167 
168 /*
169  * Configuration
170  */
171 #define PR_MAX_MACRO_ARGS       32              /* Max number of macro args */
172 #define PR_MAX_ARG_INSTANCES    24              /* Max instances of any one arg */
173 #define PR_LINES_PER_BLOCK      4096            /* Max input source lines per block */
174 
175 
176 /*
177  * Local defines and macros
178  */
179 #define PR_TOKEN_SEPARATORS     " ,(){}\t\n"
180 #define PR_MACRO_SEPARATORS     " ,(){}~!*/%+-<>=&^|\"\t\n"
181 #define PR_MACRO_ARGUMENTS      " ,\t\n"
182 #define PR_EXPR_SEPARATORS      " ,(){}~!*/%+-<>=&^|\"\t\n"
183 
184 #define PR_PREFIX_ID            "Pr(%.4u) - "             /* Used for debug output */
185 
186 #define THIS_TOKEN_OFFSET(t)    ((AslGbl_MainTokenBuffer - t) + 1)
187 
188 
189 /*
190  * Preprocessor structures
191  */
192 typedef struct pr_macro_arg
193 {
194     char                        *Name;
195     UINT32                      Offset[PR_MAX_ARG_INSTANCES];
196     UINT16                      UseCount;
197 
198 } PR_MACRO_ARG;
199 
200 typedef struct pr_define_info
201 {
202     struct pr_define_info       *Previous;
203     struct pr_define_info       *Next;
204     char                        *Identifier;
205     char                        *Replacement;
206     char                        *Body;          /* Macro body */
207     PR_MACRO_ARG                *Args;          /* Macro arg list */
208     UINT16                      ArgCount;       /* Macro arg count */
209     BOOLEAN                     Persist;        /* Keep for entire compiler run */
210 
211 } PR_DEFINE_INFO;
212 
213 typedef struct pr_directive_info
214 {
215     char                        *Name;          /* Directive name */
216     UINT8                       ArgCount;       /* Required # of args */
217 
218 } PR_DIRECTIVE_INFO;
219 
220 typedef struct pr_operator_info
221 {
222     char                        *Op;
223 
224 } PR_OPERATOR_INFO;
225 
226 typedef struct pr_file_node
227 {
228     struct pr_file_node         *Next;
229     FILE                        *File;
230     char                        *Filename;
231     UINT32                      CurrentLineNumber;
232 
233 } PR_FILE_NODE;
234 
235 #define MAX_ARGUMENT_LENGTH     24
236 
237 typedef struct directive_info
238 {
239     struct directive_info       *Next;
240     char                        Argument[MAX_ARGUMENT_LENGTH];
241     int                         Directive;
242     BOOLEAN                     IgnoringThisCodeBlock;
243 
244 } DIRECTIVE_INFO;
245 
246 
247 /*
248  * Globals
249  */
250 PR_EXTERN char                  PR_INIT_GLOBAL (*AslGbl_MainTokenBuffer, NULL); /* [ASL_LINE_BUFFER_SIZE]; */
251 PR_EXTERN char                  PR_INIT_GLOBAL (*AslGbl_MacroTokenBuffer, NULL); /* [ASL_LINE_BUFFER_SIZE]; */
252 PR_EXTERN char                  PR_INIT_GLOBAL (*AslGbl_ExpressionTokenBuffer, NULL); /* [ASL_LINE_BUFFER_SIZE]; */
253 
254 PR_EXTERN UINT32                AslGbl_PreprocessorLineNumber;
255 PR_EXTERN int                   AslGbl_IfDepth;
256 PR_EXTERN PR_FILE_NODE          *AslGbl_InputFileList;
257 PR_EXTERN BOOLEAN               PR_INIT_GLOBAL (AslGbl_PreprocessorError, FALSE);
258 PR_EXTERN BOOLEAN               PR_INIT_GLOBAL (AslGbl_IgnoringThisCodeBlock, FALSE);
259 PR_EXTERN PR_DEFINE_INFO        PR_INIT_GLOBAL (*AslGbl_DefineList, NULL);
260 PR_EXTERN DIRECTIVE_INFO        PR_INIT_GLOBAL (*AslGbl_DirectiveStack, NULL);
261 
262 #if 0 /* TBD for macros */
263 PR_EXTERN char                  PR_INIT_GLOBAL (*XXXEvalBuffer, NULL); /* [ASL_LINE_BUFFER_SIZE]; */
264 #endif
265 
266 
267 /*
268  * prscan - Preprocessor entry
269  */
270 void
271 PrInitializePreprocessor (
272     void);
273 
274 void
275 PrInitializeGlobals (
276     void);
277 
278 void
279 PrTerminatePreprocessor (
280     void);
281 
282 void
283 PrDoPreprocess (
284     void);
285 
286 UINT64
287 PrIsDefined (
288     char                    *Identifier);
289 
290 UINT64
291 PrResolveDefine (
292     char                    *Identifier);
293 
294 int
295 PrInitLexer (
296     char                    *String);
297 
298 void
299 PrTerminateLexer (
300     void);
301 
302 
303 /*
304  * prmacros - Support for #defines and macros
305  */
306 void
307 PrDumpPredefinedNames (
308     void);
309 
310 PR_DEFINE_INFO *
311 PrAddDefine (
312     char                    *Token,
313     char                    *Token2,
314     BOOLEAN                 Persist);
315 
316 void
317 PrRemoveDefine (
318     char                    *DefineName);
319 
320 PR_DEFINE_INFO *
321 PrMatchDefine (
322     char                    *MatchString);
323 
324 void
325 PrAddMacro (
326     char                    *Name,
327     char                    **Next);
328 
329 void
330 PrDoMacroInvocation (
331     char                    *TokenBuffer,
332     char                    *MacroStart,
333     PR_DEFINE_INFO          *DefineInfo,
334     char                    **Next);
335 
336 
337 /*
338  * prexpress - #if expression support
339  */
340 ACPI_STATUS
341 PrResolveIntegerExpression (
342     char                    *Line,
343     UINT64                  *ReturnValue);
344 
345 char *
346 PrPrioritizeExpression (
347     char                    *OriginalLine);
348 
349 /*
350  * prparser - lex/yacc expression parser
351  */
352 UINT64
353 PrEvaluateExpression (
354     char                    *ExprString);
355 
356 
357 /*
358  * prutils - Preprocesor utilities
359  */
360 char *
361 PrGetNextToken (
362     char                    *Buffer,
363     char                    *MatchString,
364     char                    **Next);
365 
366 void
367 PrError (
368     UINT8                   Level,
369     UINT16                  MessageId,
370     UINT32                  Column);
371 
372 void
373 PrReplaceData (
374     char                    *Buffer,
375     UINT32                  LengthToRemove,
376     char                    *BufferToAdd,
377     UINT32                  LengthToAdd);
378 
379 FILE *
380 PrOpenIncludeFile (
381     char                    *Filename,
382     char                    *OpenMode,
383     char                    **FullPathname);
384 
385 FILE *
386 PrOpenIncludeWithPrefix (
387     char                    *PrefixDir,
388     char                    *Filename,
389     char                    *OpenMode,
390     char                    **FullPathname);
391 
392 void
393 PrPushInputFileStack (
394     FILE                    *InputFile,
395     char                    *Filename);
396 
397 BOOLEAN
398 PrPopInputFileStack (
399     void);
400 
401 #endif
402