xref: /freebsd/sys/contrib/dev/acpica/compiler/dtparser.y (revision 722b16673c40aedf280895f2f2f676bb494518d7)
1 %{
2 /******************************************************************************
3  *
4  * Module Name: dtparser.y - Bison input file for table compiler parser
5  *
6  *****************************************************************************/
7 
8 /******************************************************************************
9  *
10  * 1. Copyright Notice
11  *
12  * Some or all of this work - Copyright (c) 1999 - 2023, Intel Corp.
13  * All rights reserved.
14  *
15  * 2. License
16  *
17  * 2.1. This is your license from Intel Corp. under its intellectual property
18  * rights. You may have additional license terms from the party that provided
19  * you this software, covering your right to use that party's intellectual
20  * property rights.
21  *
22  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23  * copy of the source code appearing in this file ("Covered Code") an
24  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25  * base code distributed originally by Intel ("Original Intel Code") to copy,
26  * make derivatives, distribute, use and display any portion of the Covered
27  * Code in any form, with the right to sublicense such rights; and
28  *
29  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30  * license (with the right to sublicense), under only those claims of Intel
31  * patents that are infringed by the Original Intel Code, to make, use, sell,
32  * offer to sell, and import the Covered Code and derivative works thereof
33  * solely to the minimum extent necessary to exercise the above copyright
34  * license, and in no event shall the patent license extend to any additions
35  * to or modifications of the Original Intel Code. No other license or right
36  * is granted directly or by implication, estoppel or otherwise;
37  *
38  * The above copyright and patent license is granted only if the following
39  * conditions are met:
40  *
41  * 3. Conditions
42  *
43  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44  * Redistribution of source code of any substantial portion of the Covered
45  * Code or modification with rights to further distribute source must include
46  * the above Copyright Notice, the above License, this list of Conditions,
47  * and the following Disclaimer and Export Compliance provision. In addition,
48  * Licensee must cause all Covered Code to which Licensee contributes to
49  * contain a file documenting the changes Licensee made to create that Covered
50  * Code and the date of any change. Licensee must include in that file the
51  * documentation of any changes made by any predecessor Licensee. Licensee
52  * must include a prominent statement that the modification is derived,
53  * directly or indirectly, from Original Intel Code.
54  *
55  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56  * Redistribution of source code of any substantial portion of the Covered
57  * Code or modification without rights to further distribute source must
58  * include the following Disclaimer and Export Compliance provision in the
59  * documentation and/or other materials provided with distribution. In
60  * addition, Licensee may not authorize further sublicense of source of any
61  * portion of the Covered Code, and must include terms to the effect that the
62  * license from Licensee to its licensee is limited to the intellectual
63  * property embodied in the software Licensee provides to its licensee, and
64  * not to intellectual property embodied in modifications its licensee may
65  * make.
66  *
67  * 3.3. Redistribution of Executable. Redistribution in executable form of any
68  * substantial portion of the Covered Code or modification must reproduce the
69  * above Copyright Notice, and the following Disclaimer and Export Compliance
70  * provision in the documentation and/or other materials provided with the
71  * distribution.
72  *
73  * 3.4. Intel retains all right, title, and interest in and to the Original
74  * Intel Code.
75  *
76  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77  * Intel shall be used in advertising or otherwise to promote the sale, use or
78  * other dealings in products derived from or relating to the Covered Code
79  * without prior written authorization from Intel.
80  *
81  * 4. Disclaimer and Export Compliance
82  *
83  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
86  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
87  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
88  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
89  * PARTICULAR PURPOSE.
90  *
91  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
97  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
98  * LIMITED REMEDY.
99  *
100  * 4.3. Licensee shall not export, either directly or indirectly, any of this
101  * software or system incorporating such software without first obtaining any
102  * required license or other approval from the U. S. Department of Commerce or
103  * any other agency or department of the United States Government. In the
104  * event Licensee exports any such software from the United States or
105  * re-exports any such software from a foreign destination, Licensee shall
106  * ensure that the distribution and export/re-export of the software is in
107  * compliance with all laws, regulations, orders, or other restrictions of the
108  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109  * any of its subsidiaries will export/re-export any technical data, process,
110  * software, or service, directly or indirectly, to any country for which the
111  * United States government or any agency thereof requires an export license,
112  * other governmental approval, or letter of assurance, without first obtaining
113  * such license, approval or letter.
114  *
115  *****************************************************************************
116  *
117  * Alternatively, you may choose to be licensed under the terms of the
118  * following license:
119  *
120  * Redistribution and use in source and binary forms, with or without
121  * modification, are permitted provided that the following conditions
122  * are met:
123  * 1. Redistributions of source code must retain the above copyright
124  *    notice, this list of conditions, and the following disclaimer,
125  *    without modification.
126  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
127  *    substantially similar to the "NO WARRANTY" disclaimer below
128  *    ("Disclaimer") and any redistribution must be conditioned upon
129  *    including a substantially similar Disclaimer requirement for further
130  *    binary redistribution.
131  * 3. Neither the names of the above-listed copyright holders nor the names
132  *    of any contributors may be used to endorse or promote products derived
133  *    from this software without specific prior written permission.
134  *
135  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
136  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
137  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
138  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
139  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
140  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
141  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
142  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
143  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
144  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
145  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
146  *
147  * Alternatively, you may choose to be licensed under the terms of the
148  * GNU General Public License ("GPL") version 2 as published by the Free
149  * Software Foundation.
150  *
151  *****************************************************************************/
152 
153 #include <contrib/dev/acpica/compiler/aslcompiler.h>
154 
155 #define _COMPONENT          DT_COMPILER
156         ACPI_MODULE_NAME    ("dtparser")
157 
158 void *                      AslLocalAllocate (unsigned int Size);
159 
160 /* Bison/yacc configuration */
161 
162 #undef alloca
163 #define alloca              AslLocalAllocate
164 
165 int                         DtParserlex (void);
166 int                         DtParserparse (void);
167 void                        DtParsererror (char const *msg);
168 extern char                 *DtParsertext;
169 extern DT_FIELD             *AslGbl_CurrentField;
170 
171 UINT64                      DtParserResult; /* Expression return value */
172 
173 /* Bison/yacc configuration */
174 
175 #define yytname             DtParsername
176 #define YYDEBUG             1               /* Enable debug output */
177 #define YYERROR_VERBOSE     1               /* Verbose error messages */
178 #define YYFLAG              -32768
179 
180 /* Define YYMALLOC/YYFREE to prevent redefinition errors  */
181 
182 #define YYMALLOC            malloc
183 #define YYFREE              free
184 %}
185 
186 %union
187 {
188      UINT64                 value;
189      UINT32                 op;
190 }
191 
192 /*! [Begin] no source code translation */
193 
194 %type  <value>  Expression
195 
196 %token <op>     OP_EXP_EOF
197 %token <op>     OP_EXP_NEW_LINE
198 %token <op>     OP_EXP_NUMBER
199 %token <op>     OP_EXP_HEX_NUMBER
200 %token <op>     OP_EXP_DECIMAL_NUMBER
201 %token <op>     OP_EXP_LABEL
202 %token <op>     OP_EXP_PAREN_OPEN
203 %token <op>     OP_EXP_PAREN_CLOSE
204 
205 %left <op>      OP_EXP_LOGICAL_OR
206 %left <op>      OP_EXP_LOGICAL_AND
207 %left <op>      OP_EXP_OR
208 %left <op>      OP_EXP_XOR
209 %left <op>      OP_EXP_AND
210 %left <op>      OP_EXP_EQUAL OP_EXP_NOT_EQUAL
211 %left <op>      OP_EXP_GREATER OP_EXP_LESS OP_EXP_GREATER_EQUAL OP_EXP_LESS_EQUAL
212 %left <op>      OP_EXP_SHIFT_RIGHT OP_EXP_SHIFT_LEFT
213 %left <op>      OP_EXP_ADD OP_EXP_SUBTRACT
214 %left <op>      OP_EXP_MULTIPLY OP_EXP_DIVIDE OP_EXP_MODULO
215 %right <op>     OP_EXP_ONES_COMPLIMENT OP_EXP_LOGICAL_NOT
216 
217 %%
218 
219 /*
220  *  Operator precedence rules (from K&R)
221  *
222  *  1)      ( )
223  *  2)      ! ~ (unary operators that are supported here)
224  *  3)      *   /   %
225  *  4)      +   -
226  *  5)      >>  <<
227  *  6)      <   >   <=  >=
228  *  7)      ==  !=
229  *  8)      &
230  *  9)      ^
231  *  10)     |
232  *  11)     &&
233  *  12)     ||
234  */
235 Value
236     : Expression OP_EXP_NEW_LINE                     { DtParserResult=$1; return 0; } /* End of line (newline) */
237     | Expression OP_EXP_EOF                          { DtParserResult=$1; return 0; } /* End of string (0) */
238     ;
239 
240 Expression
241 
242       /* Unary operators */
243 
244     : OP_EXP_LOGICAL_NOT         Expression          { $$ = DtDoOperator ($2, OP_EXP_LOGICAL_NOT,     $2);}
245     | OP_EXP_ONES_COMPLIMENT     Expression          { $$ = DtDoOperator ($2, OP_EXP_ONES_COMPLIMENT, $2);}
246 
247       /* Binary operators */
248 
249     | Expression OP_EXP_MULTIPLY         Expression  { $$ = DtDoOperator ($1, OP_EXP_MULTIPLY,        $3);}
250     | Expression OP_EXP_DIVIDE           Expression  { $$ = DtDoOperator ($1, OP_EXP_DIVIDE,          $3);}
251     | Expression OP_EXP_MODULO           Expression  { $$ = DtDoOperator ($1, OP_EXP_MODULO,          $3);}
252     | Expression OP_EXP_ADD              Expression  { $$ = DtDoOperator ($1, OP_EXP_ADD,             $3);}
253     | Expression OP_EXP_SUBTRACT         Expression  { $$ = DtDoOperator ($1, OP_EXP_SUBTRACT,        $3);}
254     | Expression OP_EXP_SHIFT_RIGHT      Expression  { $$ = DtDoOperator ($1, OP_EXP_SHIFT_RIGHT,     $3);}
255     | Expression OP_EXP_SHIFT_LEFT       Expression  { $$ = DtDoOperator ($1, OP_EXP_SHIFT_LEFT,      $3);}
256     | Expression OP_EXP_GREATER          Expression  { $$ = DtDoOperator ($1, OP_EXP_GREATER,         $3);}
257     | Expression OP_EXP_LESS             Expression  { $$ = DtDoOperator ($1, OP_EXP_LESS,            $3);}
258     | Expression OP_EXP_GREATER_EQUAL    Expression  { $$ = DtDoOperator ($1, OP_EXP_GREATER_EQUAL,   $3);}
259     | Expression OP_EXP_LESS_EQUAL       Expression  { $$ = DtDoOperator ($1, OP_EXP_LESS_EQUAL,      $3);}
260     | Expression OP_EXP_EQUAL            Expression  { $$ = DtDoOperator ($1, OP_EXP_EQUAL,           $3);}
261     | Expression OP_EXP_NOT_EQUAL        Expression  { $$ = DtDoOperator ($1, OP_EXP_NOT_EQUAL,       $3);}
262     | Expression OP_EXP_AND              Expression  { $$ = DtDoOperator ($1, OP_EXP_AND,             $3);}
263     | Expression OP_EXP_XOR              Expression  { $$ = DtDoOperator ($1, OP_EXP_XOR,             $3);}
264     | Expression OP_EXP_OR               Expression  { $$ = DtDoOperator ($1, OP_EXP_OR,              $3);}
265     | Expression OP_EXP_LOGICAL_AND      Expression  { $$ = DtDoOperator ($1, OP_EXP_LOGICAL_AND,     $3);}
266     | Expression OP_EXP_LOGICAL_OR       Expression  { $$ = DtDoOperator ($1, OP_EXP_LOGICAL_OR,      $3);}
267 
268       /* Parentheses: '(' Expression ')' */
269 
270     | OP_EXP_PAREN_OPEN          Expression
271         OP_EXP_PAREN_CLOSE                           { $$ = $2;}
272 
273       /* Label references (prefixed with $) */
274 
275     | OP_EXP_LABEL                                   { $$ = DtResolveLabel (DtParsertext);}
276 
277       /*
278        * All constants for the data table compiler are in hex, whether a (optional) 0x
279        * prefix is present or not. For example, these two input strings are equivalent:
280        *    1234
281        *    0x1234
282        */
283 
284       /* Non-prefixed hex number */
285 
286     | OP_EXP_NUMBER                                  { $$ = DtDoConstant (DtParsertext);}
287 
288       /* Standard hex number (0x1234) */
289 
290     | OP_EXP_HEX_NUMBER                              { $$ = DtDoConstant (DtParsertext);}
291 
292       /* Possible TBD: Decimal number with prefix (0d1234) - Not supported this time */
293 
294     | OP_EXP_DECIMAL_NUMBER                          { $$ = DtDoConstant (DtParsertext);}
295     ;
296 %%
297 
298 /*! [End] no source code translation !*/
299 
300 /*
301  * Local support functions, including parser entry point
302  */
303 #define PR_FIRST_PARSE_OPCODE   OP_EXP_EOF
304 #define PR_YYTNAME_START        3
305 
306 
307 /******************************************************************************
308  *
309  * FUNCTION:    DtParsererror
310  *
311  * PARAMETERS:  Message             - Parser-generated error message
312  *
313  * RETURN:      None
314  *
315  * DESCRIPTION: Handler for parser errors
316  *
317  *****************************************************************************/
318 
319 void
320 DtParsererror (
321     char const              *Message)
322 {
323     DtError (ASL_ERROR, ASL_MSG_SYNTAX,
324         AslGbl_CurrentField, (char *) Message);
325 }
326 
327 
328 /******************************************************************************
329  *
330  * FUNCTION:    DtGetOpName
331  *
332  * PARAMETERS:  ParseOpcode         - Parser token (OP_EXP_*)
333  *
334  * RETURN:      Pointer to the opcode name
335  *
336  * DESCRIPTION: Get the ascii name of the parse opcode for debug output
337  *
338  *****************************************************************************/
339 
340 char *
DtGetOpName(UINT32 ParseOpcode)341 DtGetOpName (
342     UINT32                  ParseOpcode)
343 {
344 #ifdef ASL_YYTNAME_START
345     /*
346      * First entries (PR_YYTNAME_START) in yytname are special reserved names.
347      * Ignore first 6 characters of name (OP_EXP_)
348      */
349     return ((char *) yytname
350         [(ParseOpcode - PR_FIRST_PARSE_OPCODE) + PR_YYTNAME_START] + 6);
351 #else
352     return ("[Unknown parser generator]");
353 #endif
354 }
355 
356 
357 /******************************************************************************
358  *
359  * FUNCTION:    DtEvaluateExpression
360  *
361  * PARAMETERS:  ExprString          - Expression to be evaluated. Must be
362  *                                    terminated by either a newline or a NUL
363  *                                    string terminator
364  *
365  * RETURN:      64-bit value for the expression
366  *
367  * DESCRIPTION: Main entry point for the DT expression parser
368  *
369  *****************************************************************************/
370 
371 UINT64
DtEvaluateExpression(char * ExprString)372 DtEvaluateExpression (
373     char                    *ExprString)
374 {
375 
376     DbgPrint (ASL_DEBUG_OUTPUT,
377         "**** Input expression: %s  (Base 16)\n", ExprString);
378 
379     /* Point lexer to the input string */
380 
381     if (DtInitLexer (ExprString))
382     {
383         DtError (ASL_ERROR, ASL_MSG_COMPILER_INTERNAL,
384             AslGbl_CurrentField, "Could not initialize lexer");
385         return (0);
386     }
387 
388     /* Parse/Evaluate the input string (value returned in DtParserResult) */
389 
390     DtParserparse ();
391     DtTerminateLexer ();
392 
393     DbgPrint (ASL_DEBUG_OUTPUT,
394         "**** Parser returned value: %u (%8.8X%8.8X)\n",
395         (UINT32) DtParserResult, ACPI_FORMAT_UINT64 (DtParserResult));
396 
397     return (DtParserResult);
398 }
399