xref: /netbsd-src/sys/external/bsd/acpica/dist/compiler/dtparser.y (revision 413d532bcc3f62d122e56d92e13ac64825a40baf)
1 %{
2 /******************************************************************************
3  *
4  * Module Name: dtparser.y - Bison input file for table compiler parser
5  *
6  *****************************************************************************/
7 
8 /*
9  * Copyright (C) 2000 - 2013, Intel Corp.
10  * All rights reserved.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
15  * 1. Redistributions of source code must retain the above copyright
16  *    notice, this list of conditions, and the following disclaimer,
17  *    without modification.
18  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
19  *    substantially similar to the "NO WARRANTY" disclaimer below
20  *    ("Disclaimer") and any redistribution must be conditioned upon
21  *    including a substantially similar Disclaimer requirement for further
22  *    binary redistribution.
23  * 3. Neither the names of the above-listed copyright holders nor the names
24  *    of any contributors may be used to endorse or promote products derived
25  *    from this software without specific prior written permission.
26  *
27  * Alternatively, this software may be distributed under the terms of the
28  * GNU General Public License ("GPL") version 2 as published by the Free
29  * Software Foundation.
30  *
31  * NO WARRANTY
32  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
33  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
34  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
35  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
36  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
37  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
38  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
39  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
41  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
42  * POSSIBILITY OF SUCH DAMAGES.
43  */
44 
45 #include "aslcompiler.h"
46 #include "dtcompiler.h"
47 
48 #define _COMPONENT          DT_COMPILER
49         ACPI_MODULE_NAME    ("dtparser")
50 
51 int                         DtParserlex (void);
52 int                         DtParserparse (void);
53 void                        DtParsererror (char const *msg);
54 extern char                 *DtParsertext;
55 extern DT_FIELD             *Gbl_CurrentField;
56 
57 UINT64                      DtParserResult; /* Expression return value */
58 
59 /* Bison/yacc configuration */
60 
61 #ifndef yytname
62 #define yytname             DtParsername
63 #endif
64 #define YYDEBUG             1               /* Enable debug output */
65 #define YYERROR_VERBOSE     1               /* Verbose error messages */
66 #define YYFLAG              -32768
67 
68 /* Define YYMALLOC/YYFREE to prevent redefinition errors  */
69 
70 #define YYMALLOC            malloc
71 #define YYFREE              free
72 %}
73 
74 %union
75 {
76      UINT64                 value;
77      UINT32                 op;
78 }
79 
80 /*! [Begin] no source code translation */
81 
82 %type  <value>  Expression
83 
84 %token <op>     EXPOP_EOF
85 %token <op>     EXPOP_NEW_LINE
86 %token <op>     EXPOP_NUMBER
87 %token <op>     EXPOP_HEX_NUMBER
88 %token <op>     EXPOP_DECIMAL_NUMBER
89 %token <op>     EXPOP_LABEL
90 %token <op>     EXPOP_PAREN_OPEN
91 %token <op>     EXPOP_PAREN_CLOSE
92 
93 %left <op>      EXPOP_LOGICAL_OR
94 %left <op>      EXPOP_LOGICAL_AND
95 %left <op>      EXPOP_OR
96 %left <op>      EXPOP_XOR
97 %left <op>      EXPOP_AND
98 %left <op>      EXPOP_EQUAL EXPOP_NOT_EQUAL
99 %left <op>      EXPOP_GREATER EXPOP_LESS EXPOP_GREATER_EQUAL EXPOP_LESS_EQUAL
100 %left <op>      EXPOP_SHIFT_RIGHT EXPOP_SHIFT_LEFT
101 %left <op>      EXPOP_ADD EXPOP_SUBTRACT
102 %left <op>      EXPOP_MULTIPLY EXPOP_DIVIDE EXPOP_MODULO
103 %right <op>     EXPOP_ONES_COMPLIMENT EXPOP_LOGICAL_NOT
104 
105 %%
106 
107 /*
108  *  Operator precedence rules (from K&R)
109  *
110  *  1)      ( )
111  *  2)      ! ~ (unary operators that are supported here)
112  *  3)      *   /   %
113  *  4)      +   -
114  *  5)      >>  <<
115  *  6)      <   >   <=  >=
116  *  7)      ==  !=
117  *  8)      &
118  *  9)      ^
119  *  10)     |
120  *  11)     &&
121  *  12)     ||
122  */
123 Value
124     : Expression EXPOP_NEW_LINE                     { DtParserResult=$1; return 0; } /* End of line (newline) */
125     | Expression EXPOP_EOF                          { DtParserResult=$1; return 0; } /* End of string (0) */
126     ;
127 
128 Expression
129 
130       /* Unary operators */
131 
132     : EXPOP_LOGICAL_NOT         Expression          { $$ = DtDoOperator ($2, EXPOP_LOGICAL_NOT,     $2);}
133     | EXPOP_ONES_COMPLIMENT     Expression          { $$ = DtDoOperator ($2, EXPOP_ONES_COMPLIMENT, $2);}
134 
135       /* Binary operators */
136 
137     | Expression EXPOP_MULTIPLY         Expression  { $$ = DtDoOperator ($1, EXPOP_MULTIPLY,        $3);}
138     | Expression EXPOP_DIVIDE           Expression  { $$ = DtDoOperator ($1, EXPOP_DIVIDE,          $3);}
139     | Expression EXPOP_MODULO           Expression  { $$ = DtDoOperator ($1, EXPOP_MODULO,          $3);}
140     | Expression EXPOP_ADD              Expression  { $$ = DtDoOperator ($1, EXPOP_ADD,             $3);}
141     | Expression EXPOP_SUBTRACT         Expression  { $$ = DtDoOperator ($1, EXPOP_SUBTRACT,        $3);}
142     | Expression EXPOP_SHIFT_RIGHT      Expression  { $$ = DtDoOperator ($1, EXPOP_SHIFT_RIGHT,     $3);}
143     | Expression EXPOP_SHIFT_LEFT       Expression  { $$ = DtDoOperator ($1, EXPOP_SHIFT_LEFT,      $3);}
144     | Expression EXPOP_GREATER          Expression  { $$ = DtDoOperator ($1, EXPOP_GREATER,         $3);}
145     | Expression EXPOP_LESS             Expression  { $$ = DtDoOperator ($1, EXPOP_LESS,            $3);}
146     | Expression EXPOP_GREATER_EQUAL    Expression  { $$ = DtDoOperator ($1, EXPOP_GREATER_EQUAL,   $3);}
147     | Expression EXPOP_LESS_EQUAL       Expression  { $$ = DtDoOperator ($1, EXPOP_LESS_EQUAL,      $3);}
148     | Expression EXPOP_EQUAL            Expression  { $$ = DtDoOperator ($1, EXPOP_EQUAL,           $3);}
149     | Expression EXPOP_NOT_EQUAL        Expression  { $$ = DtDoOperator ($1, EXPOP_NOT_EQUAL,       $3);}
150     | Expression EXPOP_AND              Expression  { $$ = DtDoOperator ($1, EXPOP_AND,             $3);}
151     | Expression EXPOP_XOR              Expression  { $$ = DtDoOperator ($1, EXPOP_XOR,             $3);}
152     | Expression EXPOP_OR               Expression  { $$ = DtDoOperator ($1, EXPOP_OR,              $3);}
153     | Expression EXPOP_LOGICAL_AND      Expression  { $$ = DtDoOperator ($1, EXPOP_LOGICAL_AND,     $3);}
154     | Expression EXPOP_LOGICAL_OR       Expression  { $$ = DtDoOperator ($1, EXPOP_LOGICAL_OR,      $3);}
155 
156       /* Parentheses: '(' Expression ')' */
157 
158     | EXPOP_PAREN_OPEN          Expression
159         EXPOP_PAREN_CLOSE                           { $$ = $2;}
160 
161       /* Label references (prefixed with $) */
162 
163     | EXPOP_LABEL                                   { $$ = DtResolveLabel (DtParsertext);}
164 
165       /* Default base for a non-prefixed integer is 16 */
166 
167     | EXPOP_NUMBER                                  { UtStrtoul64 (DtParsertext, 16, &$$);}
168 
169       /* Standard hex number (0x1234) */
170 
171     | EXPOP_HEX_NUMBER                              { UtStrtoul64 (DtParsertext, 16, &$$);}
172 
173       /* TBD: Decimal number with prefix (0d1234) - Not supported by UtStrtoul64 at this time */
174 
175     | EXPOP_DECIMAL_NUMBER                          { UtStrtoul64 (DtParsertext, 10, &$$);}
176     ;
177 %%
178 
179 /*! [End] no source code translation !*/
180 
181 /*
182  * Local support functions, including parser entry point
183  */
184 #define PR_FIRST_PARSE_OPCODE   EXPOP_EOF
185 #define PR_YYTNAME_START        3
186 
187 
188 /******************************************************************************
189  *
190  * FUNCTION:    DtParsererror
191  *
192  * PARAMETERS:  Message             - Parser-generated error message
193  *
194  * RETURN:      None
195  *
196  * DESCRIPTION: Handler for parser errors
197  *
198  *****************************************************************************/
199 
200 void
201 DtParsererror (
202     char const              *Message)
203 {
204     DtError (ASL_ERROR, ASL_MSG_SYNTAX,
205         Gbl_CurrentField, (char *) Message);
206 }
207 
208 
209 /******************************************************************************
210  *
211  * FUNCTION:    DtGetOpName
212  *
213  * PARAMETERS:  ParseOpcode         - Parser token (EXPOP_*)
214  *
215  * RETURN:      Pointer to the opcode name
216  *
217  * DESCRIPTION: Get the ascii name of the parse opcode for debug output
218  *
219  *****************************************************************************/
220 
221 char *
222 DtGetOpName (
223     UINT32                  ParseOpcode)
224 {
225 #ifdef ASL_YYTNAME_START
226     /*
227      * First entries (PR_YYTNAME_START) in yytname are special reserved names.
228      * Ignore first 6 characters of name (EXPOP_)
229      */
230     return ((char *) yytname
231         [(ParseOpcode - PR_FIRST_PARSE_OPCODE) + PR_YYTNAME_START] + 6);
232 #else
233     return ("[Unknown parser generator]");
234 #endif
235 }
236 
237 
238 /******************************************************************************
239  *
240  * FUNCTION:    DtEvaluateExpression
241  *
242  * PARAMETERS:  ExprString          - Expression to be evaluated. Must be
243  *                                    terminated by either a newline or a NUL
244  *                                    string terminator
245  *
246  * RETURN:      64-bit value for the expression
247  *
248  * DESCRIPTION: Main entry point for the DT expression parser
249  *
250  *****************************************************************************/
251 
252 UINT64
253 DtEvaluateExpression (
254     char                    *ExprString)
255 {
256 
257     DbgPrint (ASL_DEBUG_OUTPUT,
258         "**** Input expression: %s  (Base 16)\n", ExprString);
259 
260     /* Point lexer to the input string */
261 
262     if (DtInitLexer (ExprString))
263     {
264         DtError (ASL_ERROR, ASL_MSG_COMPILER_INTERNAL,
265             Gbl_CurrentField, "Could not initialize lexer");
266         return (0);
267     }
268 
269     /* Parse/Evaluate the input string (value returned in DtParserResult) */
270 
271     DtParserparse ();
272     DtTerminateLexer ();
273 
274     DbgPrint (ASL_DEBUG_OUTPUT,
275         "**** Parser returned value: %u (%8.8X%8.8X)\n",
276         (UINT32) DtParserResult, ACPI_FORMAT_UINT64 (DtParserResult));
277 
278     return (DtParserResult);
279 }
280