xref: /freebsd/sys/contrib/dev/acpica/compiler/prexpress.c (revision 5e386598a6d77973b93c073080f0cc574edda9e2)
1 /******************************************************************************
2  *
3  * Module Name: prexpress - Preprocessor #if expression support
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2017, 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 <contrib/dev/acpica/compiler/aslcompiler.h>
153 #include <contrib/dev/acpica/compiler/dtcompiler.h>
154 
155 
156 #define _COMPONENT          ASL_PREPROCESSOR
157         ACPI_MODULE_NAME    ("prexpress")
158 
159 /* Local prototypes */
160 
161 static char *
162 PrExpandMacros (
163     char                    *Line);
164 
165 
166 #ifdef _UNDER_DEVELOPMENT
167 /******************************************************************************
168  *
169  * FUNCTION:    PrUnTokenize
170  *
171  * PARAMETERS:  Buffer              - Token Buffer
172  *              Next                - "Next" buffer from GetNextToken
173  *
174  * RETURN:      None
175  *
176  * DESCRIPTION: Un-tokenized the current token buffer. The implementation is
177  *              to simply set the null inserted by GetNextToken to a blank.
178  *              If Next is NULL, there were no tokens found in the Buffer,
179  *              so there is nothing to do.
180  *
181  *****************************************************************************/
182 
183 static void
184 PrUnTokenize (
185     char                    *Buffer,
186     char                    *Next)
187 {
188     UINT32                  Length = strlen (Buffer);
189 
190 
191     if (!Next)
192     {
193         return;
194     }
195 
196     if (Buffer[Length] != '\n')
197     {
198         Buffer[strlen(Buffer)] = ' ';
199     }
200 }
201 #endif
202 
203 
204 /******************************************************************************
205  *
206  * FUNCTION:    PrExpandMacros
207  *
208  * PARAMETERS:  Line                - Pointer into the current line
209  *
210  * RETURN:      Updated pointer into the current line
211  *
212  * DESCRIPTION: Expand any macros found in the current line buffer.
213  *
214  *****************************************************************************/
215 
216 static char *
217 PrExpandMacros (
218     char                    *Line)
219 {
220     char                    *Token;
221     char                    *ReplaceString;
222     PR_DEFINE_INFO          *DefineInfo;
223     ACPI_SIZE               TokenOffset;
224     char                    *Next;
225     int                     OffsetAdjust;
226 
227 
228     strcpy (Gbl_ExpressionTokenBuffer, Gbl_CurrentLineBuffer);
229     Token = PrGetNextToken (Gbl_ExpressionTokenBuffer, PR_EXPR_SEPARATORS, &Next);
230     OffsetAdjust = 0;
231 
232     while (Token)
233     {
234         DefineInfo = PrMatchDefine (Token);
235         if (DefineInfo)
236         {
237             if (DefineInfo->Body)
238             {
239                 /* This is a macro. TBD: Is this allowed? */
240 
241                 DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
242                     "Matched Macro: %s->%s\n",
243                     Gbl_CurrentLineNumber, DefineInfo->Identifier,
244                     DefineInfo->Replacement);
245 
246                 PrDoMacroInvocation (Gbl_ExpressionTokenBuffer, Token,
247                     DefineInfo, &Next);
248             }
249             else
250             {
251                 ReplaceString = DefineInfo->Replacement;
252 
253                 /* Replace the name in the original line buffer */
254 
255                 TokenOffset = Token - Gbl_ExpressionTokenBuffer + OffsetAdjust;
256                 PrReplaceData (
257                     &Gbl_CurrentLineBuffer[TokenOffset], strlen (Token),
258                     ReplaceString, strlen (ReplaceString));
259 
260                 /* Adjust for length difference between old and new name length */
261 
262                 OffsetAdjust += strlen (ReplaceString) - strlen (Token);
263 
264                 DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
265                     "Matched #define within expression: %s->%s\n",
266                     Gbl_CurrentLineNumber, Token,
267                     *ReplaceString ? ReplaceString : "(NULL STRING)");
268             }
269         }
270 
271         Token = PrGetNextToken (NULL, PR_EXPR_SEPARATORS, &Next);
272     }
273 
274     return (Line);
275 }
276 
277 
278 /******************************************************************************
279  *
280  * FUNCTION:    PrIsDefined
281  *
282  * PARAMETERS:  Identifier          - Name to be resolved
283  *
284  * RETURN:      64-bit boolean integer value
285  *
286  * DESCRIPTION: Returns TRUE if the name is defined, FALSE otherwise (0).
287  *
288  *****************************************************************************/
289 
290 UINT64
291 PrIsDefined (
292     char                    *Identifier)
293 {
294     UINT64                  Value;
295     PR_DEFINE_INFO          *DefineInfo;
296 
297 
298     DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
299         "**** Is defined?:  %s\n", Gbl_CurrentLineNumber, Identifier);
300 
301     Value = 0; /* Default is "Not defined" -- FALSE */
302 
303     DefineInfo = PrMatchDefine (Identifier);
304     if (DefineInfo)
305     {
306         Value = ACPI_UINT64_MAX; /* TRUE */
307     }
308 
309     DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
310         "[#if defined %s] resolved to: %8.8X%8.8X\n",
311         Gbl_CurrentLineNumber, Identifier, ACPI_FORMAT_UINT64 (Value));
312 
313     return (Value);
314 }
315 
316 
317 /******************************************************************************
318  *
319  * FUNCTION:    PrResolveDefine
320  *
321  * PARAMETERS:  Identifier          - Name to be resolved
322  *
323  * RETURN:      A 64-bit boolean integer value
324  *
325  * DESCRIPTION: Returns TRUE if the name is defined, FALSE otherwise (0).
326  *
327  *****************************************************************************/
328 
329 UINT64
330 PrResolveDefine (
331     char                    *Identifier)
332 {
333     UINT64                  Value;
334     PR_DEFINE_INFO          *DefineInfo;
335 
336 
337     DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
338         "**** Resolve #define:  %s\n", Gbl_CurrentLineNumber, Identifier);
339 
340     Value = 0; /* Default is "Not defined" -- FALSE */
341 
342     DefineInfo = PrMatchDefine (Identifier);
343     if (DefineInfo)
344     {
345         Value = ACPI_UINT64_MAX; /* TRUE */
346     }
347 
348     DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
349         "[#if defined %s] resolved to: %8.8X%8.8X\n",
350         Gbl_CurrentLineNumber, Identifier, ACPI_FORMAT_UINT64 (Value));
351 
352     return (Value);
353 }
354 
355 
356 /******************************************************************************
357  *
358  * FUNCTION:    PrResolveIntegerExpression
359  *
360  * PARAMETERS:  Line                - Pointer to integer expression
361  *              ReturnValue         - Where the resolved 64-bit integer is
362  *                                    returned.
363  *
364  * RETURN:      Status
365  *
366  * DESCRIPTION: Resolve an integer expression to a single value. Supports
367  *              both integer constants and labels.
368  *
369  *****************************************************************************/
370 
371 ACPI_STATUS
372 PrResolveIntegerExpression (
373     char                    *Line,
374     UINT64                  *ReturnValue)
375 {
376     UINT64                  Result;
377     char                    *ExpandedLine;
378 
379 
380     DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
381         "**** Resolve #if:  %s\n", Gbl_CurrentLineNumber, Line);
382 
383     /* Expand all macros within the expression first */
384 
385     ExpandedLine = PrExpandMacros (Line);
386 
387     /* Now we can evaluate the expression */
388 
389     Result = PrEvaluateExpression (ExpandedLine);
390     DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
391         "**** Expression Resolved to: %8.8X%8.8X\n",
392         Gbl_CurrentLineNumber, ACPI_FORMAT_UINT64 (Result));
393 
394     *ReturnValue = Result;
395     return (AE_OK);
396 
397 #if 0
398 InvalidExpression:
399 
400     ACPI_FREE (EvalBuffer);
401     PrError (ASL_ERROR, ASL_MSG_INVALID_EXPRESSION, 0);
402     return (AE_ERROR);
403 
404 
405 NormalExit:
406 
407     DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
408         "**** Expression Resolved to: %8.8X%8.8X\n",
409         Gbl_CurrentLineNumber, ACPI_FORMAT_UINT64 (Value1));
410 
411     *ReturnValue = Value1;
412     return (AE_OK);
413 #endif
414 }
415