xref: /netbsd-src/sys/external/bsd/acpica/dist/compiler/prparser.y (revision 413d532bcc3f62d122e56d92e13ac64825a40baf)
1 %{
2 /******************************************************************************
3  *
4  * Module Name: prparser.y - Bison input file for preprocessor 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          ASL_PREPROCESSOR
49         ACPI_MODULE_NAME    ("prparser")
50 
51 int                         PrParserlex (void);
52 int                         PrParserparse (void);
53 void                        PrParsererror (char const *msg);
54 extern char                 *PrParsertext;
55 
56 UINT64                      PrParserResult; /* Expression return value */
57 
58 /* Bison/yacc configuration */
59 
60 #ifndef yytname
61 #define yytname             PrParsername
62 #endif
63 #define YYDEBUG             1               /* Enable debug output */
64 #define YYERROR_VERBOSE     1               /* Verbose error messages */
65 #define YYFLAG              -32768
66 
67 /* Define YYMALLOC/YYFREE to prevent redefinition errors  */
68 
69 #define YYMALLOC            malloc
70 #define YYFREE              free
71 %}
72 
73 %union
74 {
75      UINT64                 value;
76      UINT32                 op;
77      char                   *str;
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_RESERVED1
89 %token <op>     EXPOP_RESERVED2
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 /* Tokens above must be kept in synch with dtparser.y */
106 
107 %token <op>     EXPOP_DEFINE
108 %token <op>     EXPOP_IDENTIFIER
109 
110 %%
111 
112 /*
113  *  Operator precedence rules (from K&R)
114  *
115  *  1)      ( )
116  *  2)      ! ~ (unary operators that are supported here)
117  *  3)      *   /   %
118  *  4)      +   -
119  *  5)      >>  <<
120  *  6)      <   >   <=  >=
121  *  7)      ==  !=
122  *  8)      &
123  *  9)      ^
124  *  10)     |
125  *  11)     &&
126  *  12)     ||
127  */
128 
129 /*! [End] no source code translation !*/
130 
131 Value
132     : Expression EXPOP_NEW_LINE                     { PrParserResult=$1; return 0; } /* End of line (newline) */
133     | Expression EXPOP_EOF                          { PrParserResult=$1; return 0; } /* End of string (0) */
134     ;
135 
136 Expression
137 
138       /* Unary operators */
139 
140     : EXPOP_LOGICAL_NOT         Expression          { $$ = DtDoOperator ($2, EXPOP_LOGICAL_NOT,     $2);}
141     | EXPOP_ONES_COMPLIMENT     Expression          { $$ = DtDoOperator ($2, EXPOP_ONES_COMPLIMENT, $2);}
142 
143       /* Binary operators */
144 
145     | Expression EXPOP_MULTIPLY         Expression  { $$ = DtDoOperator ($1, EXPOP_MULTIPLY,        $3);}
146     | Expression EXPOP_DIVIDE           Expression  { $$ = DtDoOperator ($1, EXPOP_DIVIDE,          $3);}
147     | Expression EXPOP_MODULO           Expression  { $$ = DtDoOperator ($1, EXPOP_MODULO,          $3);}
148     | Expression EXPOP_ADD              Expression  { $$ = DtDoOperator ($1, EXPOP_ADD,             $3);}
149     | Expression EXPOP_SUBTRACT         Expression  { $$ = DtDoOperator ($1, EXPOP_SUBTRACT,        $3);}
150     | Expression EXPOP_SHIFT_RIGHT      Expression  { $$ = DtDoOperator ($1, EXPOP_SHIFT_RIGHT,     $3);}
151     | Expression EXPOP_SHIFT_LEFT       Expression  { $$ = DtDoOperator ($1, EXPOP_SHIFT_LEFT,      $3);}
152     | Expression EXPOP_GREATER          Expression  { $$ = DtDoOperator ($1, EXPOP_GREATER,         $3);}
153     | Expression EXPOP_LESS             Expression  { $$ = DtDoOperator ($1, EXPOP_LESS,            $3);}
154     | Expression EXPOP_GREATER_EQUAL    Expression  { $$ = DtDoOperator ($1, EXPOP_GREATER_EQUAL,   $3);}
155     | Expression EXPOP_LESS_EQUAL       Expression  { $$ = DtDoOperator ($1, EXPOP_LESS_EQUAL,      $3);}
156     | Expression EXPOP_EQUAL            Expression  { $$ = DtDoOperator ($1, EXPOP_EQUAL,           $3);}
157     | Expression EXPOP_NOT_EQUAL        Expression  { $$ = DtDoOperator ($1, EXPOP_NOT_EQUAL,       $3);}
158     | Expression EXPOP_AND              Expression  { $$ = DtDoOperator ($1, EXPOP_AND,             $3);}
159     | Expression EXPOP_XOR              Expression  { $$ = DtDoOperator ($1, EXPOP_XOR,             $3);}
160     | Expression EXPOP_OR               Expression  { $$ = DtDoOperator ($1, EXPOP_OR,              $3);}
161     | Expression EXPOP_LOGICAL_AND      Expression  { $$ = DtDoOperator ($1, EXPOP_LOGICAL_AND,     $3);}
162     | Expression EXPOP_LOGICAL_OR       Expression  { $$ = DtDoOperator ($1, EXPOP_LOGICAL_OR,      $3);}
163 
164       /* Parentheses: '(' Expression ')' */
165 
166     | EXPOP_PAREN_OPEN          Expression
167         EXPOP_PAREN_CLOSE                           { $$ = $2;}
168 
169       /* #if defined (ID) or #if defined ID */
170 
171     | EXPOP_DEFINE EXPOP_PAREN_OPEN EXPOP_IDENTIFIER
172         EXPOP_PAREN_CLOSE                           { $$ = PrIsDefined (PrParserlval.str);}
173 
174     | EXPOP_DEFINE EXPOP_IDENTIFIER                 { $$ = PrIsDefined (PrParserlval.str);}
175 
176     | EXPOP_IDENTIFIER                              { $$ = PrResolveDefine (PrParserlval.str);}
177 
178       /* Default base for a non-prefixed integer is 10 */
179 
180     | EXPOP_NUMBER                                  { UtStrtoul64 (PrParsertext, 10, &$$);}
181 
182       /* Standard hex number (0x1234) */
183 
184     | EXPOP_HEX_NUMBER                              { UtStrtoul64 (PrParsertext, 16, &$$);}
185     ;
186 %%
187 
188 /*
189  * Local support functions, including parser entry point
190  */
191 #define PR_FIRST_PARSE_OPCODE   EXPOP_EOF
192 #define PR_YYTNAME_START        3
193 
194 
195 /******************************************************************************
196  *
197  * FUNCTION:    PrParsererror
198  *
199  * PARAMETERS:  Message             - Parser-generated error message
200  *
201  * RETURN:      None
202  *
203  * DESCRIPTION: Handler for parser errors
204  *
205  *****************************************************************************/
206 
207 void
208 PrParsererror (
209     char const              *Message)
210 {
211     DtError (ASL_ERROR, ASL_MSG_SYNTAX,
212         NULL, (char *) Message);
213 }
214 
215 
216 /******************************************************************************
217  *
218  * FUNCTION:    PrGetOpName
219  *
220  * PARAMETERS:  ParseOpcode         - Parser token (EXPOP_*)
221  *
222  * RETURN:      Pointer to the opcode name
223  *
224  * DESCRIPTION: Get the ascii name of the parse opcode for debug output
225  *
226  *****************************************************************************/
227 
228 char *
229 PrGetOpName (
230     UINT32                  ParseOpcode)
231 {
232 #ifdef ASL_YYTNAME_START
233     /*
234      * First entries (PR_YYTNAME_START) in yytname are special reserved names.
235      * Ignore first 6 characters of name (EXPOP_)
236      */
237     return ((char *) yytname
238         [(ParseOpcode - PR_FIRST_PARSE_OPCODE) + PR_YYTNAME_START] + 6);
239 #else
240     return ("[Unknown parser generator]");
241 #endif
242 }
243 
244 
245 /******************************************************************************
246  *
247  * FUNCTION:    PrEvaluateExpression
248  *
249  * PARAMETERS:  ExprString          - Expression to be evaluated. Must be
250  *                                    terminated by either a newline or a NUL
251  *                                    string terminator
252  *
253  * RETURN:      64-bit value for the expression
254  *
255  * DESCRIPTION: Main entry point for the DT expression parser
256  *
257  *****************************************************************************/
258 
259 UINT64
260 PrEvaluateExpression (
261     char                    *ExprString)
262 {
263 
264     DbgPrint (ASL_DEBUG_OUTPUT,
265         "**** Input expression: %s\n", ExprString);
266 
267     /* Point lexer to the input string */
268 
269     if (PrInitLexer (ExprString))
270     {
271         DtError (ASL_ERROR, ASL_MSG_COMPILER_INTERNAL,
272             NULL, "Could not initialize lexer");
273         return (0);
274     }
275 
276     /* Parse/Evaluate the input string (value returned in PrParserResult) */
277 
278     PrParserparse ();
279     PrTerminateLexer ();
280 
281     DbgPrint (ASL_DEBUG_OUTPUT,
282         "**** Parser returned value: %u (%8.8X%8.8X)\n",
283         (UINT32) PrParserResult, ACPI_FORMAT_UINT64 (PrParserResult));
284 
285     return (PrParserResult);
286 }
287