xref: /freebsd/sys/contrib/dev/acpica/compiler/aslcstyle.y (revision 6580f5c38dd5b01aeeaed16b370f1a12423437f0)
1 NoEcho('
2 /******************************************************************************
3  *
4  * Module Name: aslcstyle.y - Production rules for symbolic operators
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 ')
154 
155 /*******************************************************************************
156  *
157  * Production rules for the symbolic (c-style) operators
158  *
159  ******************************************************************************/
160 
161 /*
162  * ASL Extensions: C-style math/logical operators and expressions.
163  * The implementation transforms these operators into the standard
164  * AML opcodes and syntax.
165  *
166  * Supported operators and precedence rules (high-to-low)
167  *
168  * NOTE: The operator precedence and associativity rules are
169  * implemented by the tokens in asltokens.y
170  *
171  * (left-to-right):
172  *  1)      ( ) expr++ expr--
173  *
174  * (right-to-left):
175  *  2)      ! ~
176  *
177  * (left-to-right):
178  *  3)      *   /   %
179  *  4)      +   -
180  *  5)      >>  <<
181  *  6)      <   >   <=  >=
182  *  7)      ==  !=
183  *  8)      &
184  *  9)      ^
185  *  10)     |
186  *  11)     &&
187  *  12)     ||
188  *
189  * (right-to-left):
190  *  13)     = += -= *= /= %= <<= >>= &= ^= |=
191  */
192 
193 
194 /*******************************************************************************
195  *
196  * Basic operations for math and logical expressions.
197  *
198  ******************************************************************************/
199 
200 Expression
201 
202     /* Unary operators */
203 
204     : PARSEOP_EXP_LOGICAL_NOT           {$<n>$ = TrCreateLeafOp (PARSEOP_LNOT);}
205         TermArg                         {$$ = TrLinkOpChildren ($<n>2,1,$3);}
206     | PARSEOP_EXP_NOT                   {$<n>$ = TrCreateLeafOp (PARSEOP_NOT);}
207         TermArg                         {$$ = TrLinkOpChildren ($<n>2,2,$3,TrCreateNullTargetOp ());}
208 
209     | SuperName PARSEOP_EXP_INCREMENT   {$<n>$ = TrCreateLeafOp (PARSEOP_INCREMENT);}
210                                         {$$ = TrLinkOpChildren ($<n>3,1,$1);}
211     | SuperName PARSEOP_EXP_DECREMENT   {$<n>$ = TrCreateLeafOp (PARSEOP_DECREMENT);}
212                                         {$$ = TrLinkOpChildren ($<n>3,1,$1);}
213 
214     /* Binary operators: math and logical */
215 
216     | TermArg PARSEOP_EXP_ADD           {$<n>$ = TrCreateLeafOp (PARSEOP_ADD);}
217         TermArg                         {$$ = TrLinkOpChildren ($<n>3,3,$1,$4,TrCreateNullTargetOp ());}
218     | TermArg PARSEOP_EXP_DIVIDE        {$<n>$ = TrCreateLeafOp (PARSEOP_DIVIDE);}
219         TermArg                         {$$ = TrLinkOpChildren ($<n>3,4,$1,$4,TrCreateNullTargetOp (),
220                                             TrCreateNullTargetOp ());}
221     | TermArg PARSEOP_EXP_MODULO        {$<n>$ = TrCreateLeafOp (PARSEOP_MOD);}
222         TermArg                         {$$ = TrLinkOpChildren ($<n>3,3,$1,$4,TrCreateNullTargetOp ());}
223     | TermArg PARSEOP_EXP_MULTIPLY      {$<n>$ = TrCreateLeafOp (PARSEOP_MULTIPLY);}
224         TermArg                         {$$ = TrLinkOpChildren ($<n>3,3,$1,$4,TrCreateNullTargetOp ());}
225     | TermArg PARSEOP_EXP_SHIFT_LEFT    {$<n>$ = TrCreateLeafOp (PARSEOP_SHIFTLEFT);}
226         TermArg                         {$$ = TrLinkOpChildren ($<n>3,3,$1,$4,TrCreateNullTargetOp ());}
227     | TermArg PARSEOP_EXP_SHIFT_RIGHT   {$<n>$ = TrCreateLeafOp (PARSEOP_SHIFTRIGHT);}
228         TermArg                         {$$ = TrLinkOpChildren ($<n>3,3,$1,$4,TrCreateNullTargetOp ());}
229     | TermArg PARSEOP_EXP_SUBTRACT      {$<n>$ = TrCreateLeafOp (PARSEOP_SUBTRACT);}
230         TermArg                         {$$ = TrLinkOpChildren ($<n>3,3,$1,$4,TrCreateNullTargetOp ());}
231 
232     | TermArg PARSEOP_EXP_AND           {$<n>$ = TrCreateLeafOp (PARSEOP_AND);}
233         TermArg                         {$$ = TrLinkOpChildren ($<n>3,3,$1,$4,TrCreateNullTargetOp ());}
234     | TermArg PARSEOP_EXP_OR            {$<n>$ = TrCreateLeafOp (PARSEOP_OR);}
235         TermArg                         {$$ = TrLinkOpChildren ($<n>3,3,$1,$4,TrCreateNullTargetOp ());}
236     | TermArg PARSEOP_EXP_XOR           {$<n>$ = TrCreateLeafOp (PARSEOP_XOR);}
237         TermArg                         {$$ = TrLinkOpChildren ($<n>3,3,$1,$4,TrCreateNullTargetOp ());}
238 
239     | TermArg PARSEOP_EXP_GREATER       {$<n>$ = TrCreateLeafOp (PARSEOP_LGREATER);}
240         TermArg                         {$$ = TrLinkOpChildren ($<n>3,2,$1,$4);}
241     | TermArg PARSEOP_EXP_GREATER_EQUAL {$<n>$ = TrCreateLeafOp (PARSEOP_LGREATEREQUAL);}
242         TermArg                         {$$ = TrLinkOpChildren ($<n>3,2,$1,$4);}
243     | TermArg PARSEOP_EXP_LESS          {$<n>$ = TrCreateLeafOp (PARSEOP_LLESS);}
244         TermArg                         {$$ = TrLinkOpChildren ($<n>3,2,$1,$4);}
245     | TermArg PARSEOP_EXP_LESS_EQUAL    {$<n>$ = TrCreateLeafOp (PARSEOP_LLESSEQUAL);}
246         TermArg                         {$$ = TrLinkOpChildren ($<n>3,2,$1,$4);}
247 
248     | TermArg PARSEOP_EXP_EQUAL         {$<n>$ = TrCreateLeafOp (PARSEOP_LEQUAL);}
249         TermArg                         {$$ = TrLinkOpChildren ($<n>3,2,$1,$4);}
250     | TermArg PARSEOP_EXP_NOT_EQUAL     {$<n>$ = TrCreateLeafOp (PARSEOP_LNOTEQUAL);}
251         TermArg                         {$$ = TrLinkOpChildren ($<n>3,2,$1,$4);}
252 
253     | TermArg PARSEOP_EXP_LOGICAL_AND   {$<n>$ = TrCreateLeafOp (PARSEOP_LAND);}
254         TermArg                         {$$ = TrLinkOpChildren ($<n>3,2,$1,$4);}
255     | TermArg PARSEOP_EXP_LOGICAL_OR    {$<n>$ = TrCreateLeafOp (PARSEOP_LOR);}
256         TermArg                         {$$ = TrLinkOpChildren ($<n>3,2,$1,$4);}
257 
258     /* Parentheses */
259 
260     | PARSEOP_OPEN_PAREN
261         Expression
262         PARSEOP_CLOSE_PAREN             {$$ = $2;}
263 
264     /* Index term -- "= BUF1[5]" on right-hand side of an equals (source) */
265 
266     | IndexExpTerm
267     ;
268 
269     /*
270      * Index term -- "BUF1[5] = " or " = BUF1[5] on either the left side
271      * of an equals (target) or the right side (source)
272      * Currently used in these terms:
273      *      Expression
274      *      ObjectTypeSource
275      *      DerefOfSource
276      *      Type6Opcode
277      */
278 IndexExpTerm
279 
280     : SuperName
281         PARSEOP_EXP_INDEX_LEFT
282         TermArg
283         PARSEOP_EXP_INDEX_RIGHT         {$$ = TrCreateLeafOp (PARSEOP_INDEX);
284                                         TrLinkOpChildren ($$,3,$1,$3,TrCreateNullTargetOp ());}
285     ;
286 
287 
288 /*******************************************************************************
289  *
290  * All assignment-type operations -- math and logical. Includes simple
291  * assignment and compound assignments.
292  *
293  ******************************************************************************/
294 
295 EqualsTerm
296 
297     /* Allow parens anywhere */
298 
299     : PARSEOP_OPEN_PAREN
300         EqualsTerm
301         PARSEOP_CLOSE_PAREN             {$$ = $2;}
302 
303     /* Simple Store() operation */
304 
305     | SuperName
306         PARSEOP_EXP_EQUALS
307         TermArg                         {$$ = TrCreateAssignmentOp ($1, $3);}
308 
309     /* Chained equals: (a=RefOf)=b, a=b=c=d etc. */
310 
311     | PARSEOP_OPEN_PAREN
312         EqualsTerm
313         PARSEOP_CLOSE_PAREN
314         PARSEOP_EXP_EQUALS
315         TermArg                         {$$ = TrCreateAssignmentOp ($2, $5);}
316 
317     /* Compound assignments -- Add (operand, operand, target) */
318 
319     | TermArg PARSEOP_EXP_ADD_EQ        {$<n>$ = TrCreateLeafOp (PARSEOP_ADD);}
320         TermArg                         {$$ = TrLinkOpChildren ($<n>3,3,$1,$4,
321                                             TrSetOpFlags (TrCreateTargetOp ($1, NULL), OP_IS_TARGET));}
322 
323     | TermArg PARSEOP_EXP_DIV_EQ        {$<n>$ = TrCreateLeafOp (PARSEOP_DIVIDE);}
324         TermArg                         {$$ = TrLinkOpChildren ($<n>3,4,$1,$4,TrCreateNullTargetOp (),
325                                             TrSetOpFlags (TrCreateTargetOp ($1, NULL), OP_IS_TARGET));}
326 
327     | TermArg PARSEOP_EXP_MOD_EQ        {$<n>$ = TrCreateLeafOp (PARSEOP_MOD);}
328         TermArg                         {$$ = TrLinkOpChildren ($<n>3,3,$1,$4,
329                                             TrSetOpFlags (TrCreateTargetOp ($1, NULL), OP_IS_TARGET));}
330 
331     | TermArg PARSEOP_EXP_MUL_EQ        {$<n>$ = TrCreateLeafOp (PARSEOP_MULTIPLY);}
332         TermArg                         {$$ = TrLinkOpChildren ($<n>3,3,$1,$4,
333                                             TrSetOpFlags (TrCreateTargetOp ($1, NULL), OP_IS_TARGET));}
334 
335     | TermArg PARSEOP_EXP_SHL_EQ        {$<n>$ = TrCreateLeafOp (PARSEOP_SHIFTLEFT);}
336         TermArg                         {$$ = TrLinkOpChildren ($<n>3,3,$1,$4,
337                                             TrSetOpFlags (TrCreateTargetOp ($1, NULL), OP_IS_TARGET));}
338 
339     | TermArg PARSEOP_EXP_SHR_EQ        {$<n>$ = TrCreateLeafOp (PARSEOP_SHIFTRIGHT);}
340         TermArg                         {$$ = TrLinkOpChildren ($<n>3,3,$1,$4,
341                                             TrSetOpFlags (TrCreateTargetOp ($1, NULL), OP_IS_TARGET));}
342 
343     | TermArg PARSEOP_EXP_SUB_EQ        {$<n>$ = TrCreateLeafOp (PARSEOP_SUBTRACT);}
344         TermArg                         {$$ = TrLinkOpChildren ($<n>3,3,$1,$4,
345                                             TrSetOpFlags (TrCreateTargetOp ($1, NULL), OP_IS_TARGET));}
346 
347     | TermArg PARSEOP_EXP_AND_EQ        {$<n>$ = TrCreateLeafOp (PARSEOP_AND);}
348         TermArg                         {$$ = TrLinkOpChildren ($<n>3,3,$1,$4,
349                                             TrSetOpFlags (TrCreateTargetOp ($1, NULL), OP_IS_TARGET));}
350 
351     | TermArg PARSEOP_EXP_OR_EQ         {$<n>$ = TrCreateLeafOp (PARSEOP_OR);}
352         TermArg                         {$$ = TrLinkOpChildren ($<n>3,3,$1,$4,
353                                             TrSetOpFlags (TrCreateTargetOp ($1, NULL), OP_IS_TARGET));}
354 
355     | TermArg PARSEOP_EXP_XOR_EQ        {$<n>$ = TrCreateLeafOp (PARSEOP_XOR);}
356         TermArg                         {$$ = TrLinkOpChildren ($<n>3,3,$1,$4,
357                                             TrSetOpFlags (TrCreateTargetOp ($1, NULL), OP_IS_TARGET));}
358     ;
359